ListDataServiceFolders - DataWorks - Alibaba Cloud Documentation Center

Queries folders.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	Yes	The number of entries per page. Default value: 10. Maximum value: 100.	10
ProjectId	long	Yes	The ID of the workspace.	10001
TenantId	long	No	The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the DataStudio page. On the page that appears, click the username for the logon in the upper-right corner and click User Info in the Menu section.	10002
GroupId	string	No	The ID of the business process to which the folders belong.	ds_123abc
FolderNameKeyword	string	No	The keyword in folder names. The keyword is used to search for folders whose names contain this keyword.	Keyword in folder names

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0000-ABCD-EF****
FolderPagingResult	object	The paging result for the folders.
PageNumber	integer	The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
TotalCount	integer	The total number of entries returned.	100
Folders	array<object>	The folders.
Folder	object
ParentId	long	The ID of the parent folder. The ID of the root folder in a business process is 0, and the ID of a folder created by a user in a business process is greater than 0.	0
ModifiedTime	string	The time when the folder was last modified.	2020-09-24T18:37:51+0800
GroupId	string	The ID of the business process to which the folder belongs.	ds_1234
FolderId	long	The folder ID.	11
FolderName	string	The name of the folder.	test1
ProjectId	long	The workspace ID.	10001
CreatedTime	string	The time when the folder was created.	2020-09-24T18:37:51+0800
TenantId	long	The tenant ID.	10002

Examples

Sample success responses

JSONformat

{
  "RequestId": "0000-ABCD-EF****",
  "FolderPagingResult": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Folders": [
      {
        "ParentId": 0,
        "ModifiedTime": "2020-09-24T18:37:51+0800",
        "GroupId": "ds_1234",
        "FolderId": 11,
        "FolderName": "test1",
        "ProjectId": 10001,
        "CreatedTime": "2020-09-24T18:37:51+0800",
        "TenantId": 10002
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.	-
429	Throttling.System	The DataWorks system is busy. Try again later.	-
429	Throttling.User	Your request is too frequent. Try again later.	-
500	InternalError.System	An internal system error occurred. Try again later.	-
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-10-09	The Error code has changed	View Change Details