ListFolders - DataWorks - Alibaba Cloud Documentation Center

Queries a list of 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
ProjectId	long	No	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.	10000
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.	dw_project
ParentFolderPath	string	Yes	The path of the parent folder.	Business_process/my_first_business_process/MaxCompute
PageNumber	integer	Yes	The page number of the request. Used for pagination.	1
PageSize	integer	Yes	The number of records per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	Responses
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message	The connection does not exist.
RequestId	string	The request ID. Used to troubleshoot errors.	0000-ABCD-****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request was successful. Valid values: true: success. false: failure.	true
Data	object	The list of folders that meet the conditions.
PageNumber	integer	The current page number.	1
PageSize	integer	The number of records on the current page.	10
TotalCount	integer	The total number of records that meet the query conditions.	13
Folders	array<object>	The list of folders.
Folders	object	The folder details.
FolderPath	string	The folder path.	Business_process/my_first_business_process/MaxCompute/ods_layer
FolderId	string	The folder ID.	2735c2****

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Folders": [
      {
        "FolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer",
        "FolderId": "2735c2****"
      }
    ]
  }
}

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.