Queries information about table folders and table 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 Yes GetMetaTableThemeLevel

The operation that you want to perform.

DataSourceType String Yes odps

The type of the data source. Set the value to odps.

RegionId String Yes cn-shanghai

The ID of the region in which DataWorks is activated. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint that is used to call the operation.

TableGuid String Yes odps.project1.name1

The globally unique identifier (GUID) of the table. Specify the GUID in the format of odps.${projectName}.${tableName}.

Response parameters

Parameter Type Example Description
Entity Struct

The returned data.

Level Array of Level

The information about the table level.

Description String Description

The description of the table level.

LevelId Long 1

The ID of the table level.

Name String Level 1

The name of the table level.

Type Integer 1

The type of the table level. Valid values:

  • 1: indicates the logical level.
  • 2: indicates the physical level.
Theme Array of Theme

The information about the table folder.

Level Integer 1

The level of the table folder. Valid values:

  • 1: indicates a table folder of level 1.
  • 2: indicates a table folder of level 2.
Name String theme1

The name of the table folder.

ParentId Long 0

The ID of the parent table folder.

ThemeId Long 123

The ID of the table folder.

ErrorCode String 0

The error code returned.

ErrorMessage String success

The error message returned.

HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String 1324afdsfde

The ID of the request. You can troubleshoot errors based on the ID.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetMetaTableThemeLevel
&DataSourceType=odps
&RegionId=cn-shanghai
&TableGuid=odps.project1.name1
&<Common request parameters>

Sample success responses

XML format

<Entity>
    <Theme>
        <ParentId>0</ParentId>
        <ThemeId>123</ThemeId>
        <Level>1</Level>
        <Name>theme1</Name>
    </Theme>
    <Level>
        <Type>1</Type>
        <Description>Description</Description>
        <LevelId>1</LevelId>
        <Name>level1</Name>
    </Level>
</Entity>
<RequestId>1324afdsfde</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<ErrorCode>0</ErrorCode>
<ErrorMessage>success</ErrorMessage>
<Success>true</Success>

JSON format

{
    "Entity": {
        "Theme": {
            "ParentId": 0,
            "ThemeId": 123,
            "Level": 1,
            "Name": "theme1"
        },
        "Level": {
            "Type": 1,
            "Description": "Description",
            "LevelId": 1,
            "Name": "level1"
        }
    },
    "RequestId": "1324afdsfde",
    "HttpStatusCode": 200,
    "ErrorCode": 0,
    "ErrorMessage": "success",
    "Success": true
}

Error codes

HttpCode Error code Error message Description
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error occurred. Try again later.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the number of requests per day for the resource has exceeded the upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
403 Forbidden.Meta.NoTenant The user is not the owner of any tenants. The error message returned because the current user is not a tenant owner.
500 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. The error message returned because the system failed to obtain a compute engine instance based on the specified MaxCompute project.
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. The error message returned because the network cannot be connected.
500 InternalError.Meta.Unknown An unknown error occurred while processing your request. The error message returned because an unknown error has occurred.
400 Invalid.Meta.TableNotExist The table does not exist. The error message returned because the specified table does not exist.
400 InvalidParameter.Meta.CommonError The specified parameter is invalid. The error message returned because the values specified for one or more request parameters are invalid.
400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. The error message returned because the specified app GUID is invalid.
400 InvalidParameter.Meta.IllegalDate The date format is invalid. The error message returned because the date format is invalid.
400 InvalidParameter.Meta.IllegalPageError The parameter for paging is invalid. The error message returned because the value of the parameter for paging is invalid.
400 InvalidParameter.Meta.NotExist The object does not exist. The error message returned because the object that you query does not exist.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition.

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