All Products
Search
Document Center

:GetDataServiceFolder

最終更新日:May 10, 2024

Queries the information about 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

GetDataServiceFolder

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

TenantId

Long

No

10003

The tenant ID. This parameter is deprecated. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.

ProjectId

Long

Yes

10002

The workspace ID.

FolderId

Long

Yes

10001

The folder ID.

Response parameters

Parameter

Type

Example

Description

RequestId

String

0000-ABCD-EF****

The request ID.

Folder

Object

The details of the folder.

ParentId

Long

0

The parent folder ID. The ID of the root folder in a business process is 0, and the ID of a folder created by a user in a business process is greater than 0.

ModifiedTime

String

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

The time when the folder was last modified.

GroupId

String

ds_1234

The ID of the business process to which the folder belongs.

FolderId

Long

11

The folder ID.

ProjectId

Long

10001

The workspace ID.

FolderName

String

test1

The name of the folder.

CreatedTime

String

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

The time when the folder was created.

TenantId

Long

10002

The tenant ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetDataServiceFolder
&TenantId=10003
&ProjectId=10002
&FolderId=10001
&<Common request parameters>

Sample success responses

XML format

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

<GetDataServiceFolderResponse>
    <RequestId>0000-ABCD-EF****</RequestId>
    <Folder>
        <ParentId>0</ParentId>
        <ModifiedTime>2020-09-24T18:37:51+0800</ModifiedTime>
        <GroupId>ds_1234</GroupId>
        <FolderId>11</FolderId>
        <ProjectId>10001</ProjectId>
        <FolderName>test1</FolderName>
        <CreatedTime>2020-09-24T18:37:51+0800</CreatedTime>
        <TenantId>10002</TenantId>
    </Folder>
</GetDataServiceFolderResponse>

JSON format

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

{
  "RequestId" : "0000-ABCD-EF****",
  "Folder" : {
    "ParentId" : 0,
    "ModifiedTime" : "2020-09-24T18:37:51+0800",
    "GroupId" : "ds_1234",
    "FolderId" : 11,
    "ProjectId" : 10001,
    "FolderName" : "test1",
    "CreatedTime" : "2020-09-24T18:37:51+0800",
    "TenantId" : 10002
  }
}

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 occurred. Try again later.

500

InternalError.UserId.Missing

An internal system error occurred. Try again later.

An internal error occurred. Try again later.

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