Queries the complete information about a table, including the 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 Yes GetMetaTableFullInfo

The operation that you want to perform.

RegionId String Yes cn-shanghai

The ID of the region where your project resides.

TableGuid String Yes odps.engine_name.table_name

The globally unique identifier (GUID) of the table.

PageNum Integer No 1

The page number to be queried.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.

ClusterId String No abc

The ID of the e-MapReduce cluster.

DatabaseName String No abc

The name of the database.

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 e-MapReduce cluster.

ColumnList Array of ColumnList

The list of fields.

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.

ColumnType String string

The type of the field.

Comment String comment

The description of the field.

IsForeignKey Boolean true

Specifies 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 remarks 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

The name of the database.

EnvType Integer 1

The environment type. A value of 0 indicates the development table and a value of 1 indicates the production table.

IsVisible Integer 1

Visibility: 0 indicates that the workspace members are visible, 1 indicates that the members in the workspace are visible, 2 indicates that the members in the workspace are visible, and 3 indicates that the owner is visible.

LastAccessTime Long 1589870294000

The time of the last access.

LastDdlTime Long 1589870294000

The time when the table structure 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://

The storage path of the Hive table.

OwnerId String 123

The ID of the table owner.

PartitionKeys String abc

The primary 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 1031203110005

The error code.

ErrorMessage String The specified parameters are invalid.

The error 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.

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>1031203110005</ErrorCode> <ErrorMessage>The specified parameters are invalid. </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": 1031203110005, "ErrorMessage": "The specified parameters are invalid.", "Success": true } 
   

Error codes

HttpCode Error codes Error message Description
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.
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.
403 Forbidden.Meta.NoTenant The user is not the owner of any tenants. The current user is not the owner of any of the tenants.
500 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. Failed to get compute engine based on maxcompute project {0}.
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. The interface network is disconnected.
500 InternalError.Meta.Unknown An unknown error occurred while processing your request. Resolve the error based on the error message.
400 InvalidParameter.Meta.CommonError The specified parameter is invalid. The error message returned because one or more request parameters are invalid.
400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. The error message returned because the App parameter is 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.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. You have restricted access. Please activate DataWorks Enterprise Edition or above.

Go to the Error CenterFor more information, see error codes.