Queries the field information about a table.

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 GetMetaTableColumn

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 number of data pages that are requested.
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 data type. Valid values: maxcompute and emr.

Response parameters

Parameter Type Example Description
Data Struct

Business data.
ColumnList Array of ColumnList

The information about the field.
Caption String data column

The description of the field.
ColumnGuid String odps.engine_name.table_name.name

The unique identifier of the field.
ColumnName String name

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 false

Indicates whether the field is a partition field.
IsPrimaryKey Boolean false

Indicates whether it is a primary key.
PageNum Integer 1

The number of data pages that are requested.
PageSize Integer 10

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

The total number of fields.
ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code.
ErrorMessage String The connection does not exist.

The error message.
HttpStatusCode Integer 200

The HTTP status code.
RequestId String 0bc1ec92159376

The ID of the request.
Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests


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

Sample success responses

XML format 


     <RequestId>0bc1ec92159376</RequestId> <HttpStatusCode>200</HttpStatusCode> <Data> <TotalCount>100</TotalCount> <PageNum>1</PageNum> <PageSize>10</PageSize> <ColumnList> <ColumnName>name</ColumnName> <Comment>comment </Comment> <ColumnGuid>odps.engine_name.table_name.name</ColumnGuid> <ColumnType>string</ColumnType> <IsPartitionColumn>false</IsPartitionColumn> <IsForeignKey>true</IsForeignKey> <Caption>data column</Caption> <IsPrimaryKey>false</IsPrimaryKey> </ColumnList> </Data> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <Success>true</Success>

JSON Format 


     { "RequestId": "0bc1ec92159376", "HttpStatusCode": 200, "Data": { "TotalCount": "100", "PageNum": "1", "PageSize": "10", "ColumnList": { "ColumnName": "name", "Comment": "comment ", "ColumnGuid": "odps.engine_name.table_name.name", "ColumnType": "string", "IsPartitionColumn": "false", "IsForeignKey": "true", "Caption": "data column", "IsPrimaryKey": "false" } }, "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "Success": true }

Error codes

HttpCode Error codes Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. You have restricted access. Please activate DataWorks Enterprise Edition or above.
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.GuidFormat The GUID format is invalid. Bad Guid information.
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.

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