Queries one or more folders in DataService Studio.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListDataServiceFolders

The operation that you want to perform.

PageNumber Integer Yes 1

The number of the page to return. Pages start from page 1. Default value: 1

PageSize Integer Yes 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.

ProjectId Long Yes 10001

The ID of the DataWorks workspace.

RegionId String Yes cn-shanghai

The ID of the region where your project resides.

TenantId Long Yes 10002

The ID of the tenant.

GroupId String No ds_123abc

The ID of the workflow to which the folder belongs.

FolderNameKeyword String No Folder keyword

Enter a keyword of the folder name to use for substring matching.

Response parameters

Parameter Type Example Description
FolderPagingResult Struct

The paging result of the folder list.

Folders Array of Folder

The list of folders.

CreatedTime String 2020-09-24T18:37:51+0800

The time when the folder was created.

FolderId Long 11

ID of the folder.

FolderName String test1

The name of the folder.

GroupId String ds_1234

The ID of the workflow to which the folder belongs.

ModifiedTime String 2020-09-24T18:37:51+0800

The editing time of the folder.

ParentId Long 0

The ID of the parent folder. The root folder ID under the workflow is equal to 0, and the ID of the user-created folder is greater than 0.

ProjectId Long 10001

The ID of the DataWorks workspace.

TenantId Long 10002

The ID of the tenant.

PageNumber Integer 1

The number of the page, which is consistent with the PageNumber value in the request.

PageSize Integer 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.

TotalCount Integer 100

The total number of entries.

RequestId String 0000-ABCD-EF****

The unique ID of the request.

Examples

Sample requests


     http(s)://[Endpoint]/? Action=ListDataServiceFolders &PageNumber=1 &PageSize=10 &ProjectId=10001 &RegionId=cn-shanghai &TenantId=10002 &<common request parameters> 
   

Sample success responses

XML format


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

JSON Format


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

Error codes

HttpCode Error codes Error message Description
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
429 Throttling.Api The request for this resource has exceeded your available limit. The request for the resource exceeds your available upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks the system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. You have restricted access. Please activate DataWorks Enterprise Edition or above.

Go to the Error Center For more information, see error codes.