Queries a folder in DataService Studio.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | GetDataServiceFolder |
The operation that you want to perform. |
FolderId | Long | Yes | 10001 |
ID of the folder. |
ProjectId | Long | Yes | 10002 |
The ID of the DataWorks workspace. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where your project resides. |
TenantId | Long | Yes | 10003 |
The ID of the tenant. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Folder | Struct |
Folder details. |
|
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 |
Parent folder ID. 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. |
RequestId | String | 0000-ABCD-EF**** |
The unique ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=GetDataServiceFolder &FolderId=10001 &ProjectId=10002 &RegionId=cn-shanghai &TenantId=10003 &<common request parameters>
Sample success responses
XML
format
<RequestId>0000-ABCD-EF****</RequestId> <Folder> <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> </Folder>
JSON
Format
{ "RequestId": "0000-ABCD-EF****", "Folder": { "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. |
403 | ResourceNotAuthorized.Api | You are not authorized to access the resources. | You cannot access resources without authorization. |
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. |
Go to the Error Center For more information, see error codes.