Queries the details of a folder.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | GetFolder |
The operation that you want to perform. |
FolderId | String | Yes | 273**** |
ID of the folder. |
FolderPath | String | Yes | Workflow /my first workflow /MaxCompute/ods |
Description: the path of the folder. Either folder or folderId must be specified. |
ProjectId | Long | Yes | 10000 |
Dataworks workspace ID and click the workspace manage icon in the upper-right corner to view the workspace information. |
RegionId | String | Yes | cn-zhangjiakou |
The list of regions where the services are located. |
ProjectIdentifier | String | No | dw_project |
Dataworks unique identifier of the workspace, that is, the name of the workspace at the top of the data Development page. You must specify either this parameter or the ProjectId parameter to determine the Dataworks workspace for the current API call. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Data | Struct |
Folder details. |
|
FolderId | String | 2735**** |
Folder ID, which you can call ListFolders Get. |
FolderPath | String | Workflow /my first workflow /MaxCompute/ods |
The path to the folder. |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists |
The error code. |
ErrorMessage | String | The connection does not exist. |
The error message. |
HttpStatusCode | Integer | 200 |
The HTTP status code. |
RequestId | String | 0000-ABCD-EFG**** |
The unique ID of the call. You can use the error ID to troubleshoot the error. |
Success | Boolean | true |
Indicates whether the request was successful. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=GetFolder &FolderId=273**** &FolderPath= workflow /my first workflow /MaxCompute/ods layer&ProjectId=10000 &RegionId=cn-zhangjiakou &<common request parameters>
Sample success responses
XML
format
<RequestId> 0000-abcd-efg**** </RequestId> <HttpStatusCode> 200 </HttpStatusCode> <Data> <FolderPath> Workflow /my first workflow /MaxCompute/ods layer </FolderPath> <FolderId> 2735 c2c19d58 </FolderId> </Data> <Success> true </Success>
JSON
Format
{"RequestId": "0000-ABCD-EFG****", "HttpStatusCode": 200, "Data": { "FolderPath": "workflow /my first workflow /MaxCompute/ods layer", "FolderId": "2735 c2c19d58" }, "Success": true}
Error codes
HttpCode | Error codes | Error message | Description |
---|---|---|---|
403 | Forbidden.Access | Access is forbidden. Activate DataWorks first. | You have restricted access. Please activate DataWorks Enterprise Edition or above. |
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 CenterFor more information, see error codes.