You can call this operation to query the list of hierarchy levels.

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 Required ListTableLevel

The operation that you want to perform.
LevelType Integer Yes 1

The level of data. Valid values: 1 (logical level) and 2 (physical level).
ProjectId Long Yes 123

The ID of the DataWorks workspace.
RegionId String Required cn-shanghai

The ID of the region where the event occurred.

Response parameters

Parameter Type Example Description
ErrorCode String 0

The error code.
ErrorMessage String success

The returned message.
HttpStatusCode Integer 200

The HTTP status code.
RequestId String abc

The ID of the request.
Success Boolean true

Indicates whether the hierarchy list is queried.
TableLevelInfo Struct

The information of the hierarchy.
LevelList Array of LevelList

The list of levels.
Description String Level Description

The description of the hierarchy.
LevelId Long 123

The level ID.
LevelType Integer 1

The level of data. Valid values: 1 (logical level) and 2 (physical level).
Name String Level 1

The name of the hierarchy.
ProjectId Long 123

The ID of the DataWorks workspace.
TotalCount Long 10

The total number of levels.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListTableLevel
&LevelType=1
&ProjectId=123
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format 

<TableLevelInfo>
    <TotalCount>10</TotalCount>
    <LevelList>
        <Description> level description </Description>
        <LevelType>1</LevelType>
        <ProjectId>123</ProjectId>
        <LevelId>123</LevelId>
        <Name> level 1 </Name>
    </LevelList>
</TableLevelInfo>
<RequestId>abc</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<ErrorCode>0</ErrorCode>
<ErrorMessage>success</ErrorMessage>
<Success>true</Success>

JSON format 

{
    "TableLevelInfo": {
        "TotalCount": 10,
        "LevelList": {
            "Description": "hierarchy Description",
            "LevelType": 1,
            "ProjectId": 123,
            "LevelId": 123,
            "Name": "Level 1"
        }
    },
    "RequestId": "abc",
    "HttpStatusCode": 200,
    "ErrorCode": 0,
    "ErrorMessage": "success",
    "Success": true
}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
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.Api.Risk The request for this resource has exceeded your daily available limit. The request for the resource has exceeded your daily availability 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.

For a list of error codes, visit the API Error Center.