All Products
Search
Document Center

DataWorks:GetFolder

Last Updated:Sep 22, 2023

Queries the details of a folder.

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 GetFolder

The operation that you want to perform. Set the value to GetFolder.

ProjectId Long No 10000

The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.

ProjectIdentifier String No dw_project

The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.

FolderId String No 273****

The ID of the folder. You must configure either this parameter or the FolderPath parameter. You can call the ListFolders operation to query the ID.

FolderPath String No Workflow/1/MaxCompute/ods

The path of the folder. You must configure either this parameter or the FolderId parameter. You can call the ListFolders operation to query the path.

Response parameters

Parameter

Type

Example

Description

HttpStatusCode Integer 200

The HTTP status code.

ErrorMessage String The connection does not exist.

The error message.

RequestId String 0000-ABCD-EFG****

The request ID. You can troubleshoot issues based on the ID.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code.

Success Boolean true

Indicates whether the request was successful.

Data Object

The details of the folder.

FolderPath String Workflow/1/MaxCompute/ods

The path of the folder.

FolderId String 2735****

The ID of the folder.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetFolder
&FolderId=273****
&FolderPath=Workflow/1/MaxCompute/ods
&RegionId=cn-zhangjiakou
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <FolderPath>Workflow/1/MaxCompute/ods</FolderPath>
    <FolderId>2735****</FolderId>
</Data>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0000-ABCD-EFG****",
  "HttpStatusCode" : 200,
  "Data" : {
    "FolderPath" : "Workflow/1/MaxCompute/ods",
    "FolderId" : "2735****"
  },
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "ErrorMessage" : "The connection does not exist.",
  "Success" : true
}

Error codes

HTTP status code

Error code

Error message

Description

429 Throttling.Api The request for this resource has exceeded your available limit. The number of requests for the resource has exceeded the upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. Excessive requests have been submitted within a short period of time. Try again later.
500 InternalError.System An internal system error occurred. Try again later. An internal error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal error has occurred. Try again later.

For a list of error codes, see Service error codes.