Call GetMetaTableFullInfo to obtain complete table information, including field information.

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 GetMetaTableFullInfo

The operation that you want to perform.

RegionId String Required cn-shanghai

The ID of the region where your project resides.

TableGuid String Required odps.engine_name.table_name

The globally unique identifier (GUID) of the table.

PageNum Integer No 1

The number of the page to return.

PageSize Integer No 10

The size of each page in the paged query.

ClusterId String No abc

The id of the emr cluster. For emr scenarios

DatabaseName String No abc

Database Name

TableName String No abc

The name of the table.

DataSourceType String No emr

The type of the database engine. Maxcompute or emr

Response parameters

Parameter Type Example Description
Data Struct

Business data.

ClusterId String abc

The id of the emr cluster.

ColumnList Array of ColumnList

The field list.

Caption String data comment

The description of the field.

ColumnGuid String odps.engine_name.table_name.1

The unique identifier of the field.

ColumnName String 1

The name of the field to be sampled.

ColumnType String string

The type of the field.

Comment String comment

The remarks about the field.

IsForeignKey Boolean true

Indicates whether the key is a foreign key.

IsPartitionColumn Boolean true

Indicates whether the field is a partition field.

IsPrimaryKey Boolean false

Indicates whether it is a primary key.

Comment String comment

The description of the table.

CreateTime Long 1589870293000

The time when the table was created.

DataSize Long 10

The storage space occupied by the table.

DatabaseName String abc

Database Name

EnvType Integer 1

Environment type: 0 indicates that a table is developed, and 1 indicates that a table is in the production environment.

IsVisible Integer 1

Visibility: 0 indicates that the workspace member is visible, 1 indicates that the tenant is visible, 2 indicates that the tenant is visible, and 3 indicates that the owner is visible.

LastAccessTime Long 1589870294000

The last access time.

LastDdlTime Long 1589870294000

The time when the table schema was last changed.

LastModifyTime Long 1589870294000

The time when the table was last updated.

LifeCycle Integer 5

The lifecycle of the table.

Location String hdfs://

Table storage address in hive

OwnerId String 123

The ID of the table owner.

PartitionKeys String abc

Partition key

ProjectId Long 22

The ID of the DataWorks workspace.

ProjectName String test

The name of the workspace.

TableGuid String odps.engine_name.table_name

The globally unique identifier (GUID) of the table.

TableName String table_name

The name of the table.

TenantId Long 12345

The ID of the tenant.

TotalColumnCount Long 22

The total number of fields.

ErrorCode String success

The error code.

ErrorMessage String success

The returned message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0bc1411515937****

The ID of the request.

Success Boolean true

Indicates whether the request is successful. A value of true indicates that the request is successful. A value of false indicates that the request has failed.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetMetaTableFullInfo
&RegionId=cn-shanghai
&TableGuid=odps.engine_name.table_name
&<Common request parameters>

Sample success responses

XML format

<RequestId>0bc1411515937****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <LifeCycle>5</LifeCycle>
    <Comment>comment</Comment>
    <ProjectName>test</ProjectName>
    <ClusterId>abc</ClusterId>
    <LastDdlTime>1589870294000</LastDdlTime>
    <CreateTime>1589870293000</CreateTime>
    <TotalColumnCount>22</TotalColumnCount>
    <ProjectId>22</ProjectId>
    <DatabaseName>abc</DatabaseName>
    <LastModifyTime>1589870294000</LastModifyTime>
    <LastAccessTime>1589870294000</LastAccessTime>
    <EnvType>1</EnvType>
    <TableName>table_name</TableName>
    <TableGuid>odps.engine_name.table_name</TableGuid>
    <TenantId>12345</TenantId>
    <OwnerId>123</OwnerId>
    <DataSize>10</DataSize>
    <PartitionKeys>abc</PartitionKeys>
    <ColumnList>
        <ColumnName>1</ColumnName>
        <Comment>comment</Comment>
        <ColumnGuid>odps.engine_name.table_name.1</ColumnGuid>
        <ColumnType>string</ColumnType>
        <IsPartitionColumn>true</IsPartitionColumn>
        <IsForeignKey>true</IsForeignKey>
        <Caption>data comment</Caption>
        <IsPrimaryKey>false</IsPrimaryKey>
    </ColumnList>
    <IsVisible>1</IsVisible>
    <Location>hdfs://</Location>
</Data>
<ErrorCode>success</ErrorCode>
<ErrorMessage>success</ErrorMessage>
<Success>true</Success>

JSON format

{"RequestId":"0bc1411515937****","HttpStatusCode":"200","Data":{"LifeCycle":"5","Comment":"comment","ProjectName":"test","ClusterId":"abc","LastDdlTime":"1589870294000","CreateTime":"1589870293000","TotalColumnCount":"22","ProjectId":"22","DatabaseName":"abc","LastModifyTime":"1589870294000","LastAccessTime":"1589870294000","EnvType":"1","TableName":"table_name","TableGuid":"odps.engine_name.table_name","TenantId":"12345","OwnerId":"123","DataSize":"10","PartitionKeys":"abc","ColumnList":[{"ColumnName":"1","Comment":"comment","ColumnGuid":"odps.engine_name.table_name.1","ColumnType":"string","IsPartitionColumn":"true","IsForeignKey":"true","Caption":"data comment","IsPrimaryKey":"false"}],"IsVisible":"1","Location":"hdfs://"},"ErrorCode":"success","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, probably 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 to 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 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.
403 Forbidden.Meta.NoTenant The user is not the owner of any tenants. The current user is not the owner of any tenant.
500 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. Failed to retrieve the compute engine based on maxcompute project {0}.
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. The network of the interface is disconnected.
500 InternalError.Meta.Unknown An unknown error occurred while processing your request. An unknown error has occurred.
400 InvalidParameter.Meta.CommonError The specified parameter is invalid. The error message returned because one or more request parameters are invalid.
400 InvalidParameter.Meta.GuidFormat The GUID format is invalid. Guid information error.
400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. The error message returned because the specified App parameters are invalid.
400 InvalidParameter.Meta.IllegalDate The date format is invalid. Date format error.
400 InvalidParameter.Meta.IllegalPageError The parameter for paging is invalid. The pagination information is incorrect.
400 InvalidParameter.Meta.NotExist The object does not exist. Data does not exist.

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