Queries the field information of 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 region ID. 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.engine_name.table_name

The GUID of the table. You can call the GetMetaDBTableList operation to query the GUID of the table.

PageNum Integer No 1

The number of the page to return.

PageSize Integer No 10

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

ClusterId String No C-010A704DA760****

The ID of the E-MapReduce (EMR) cluster. You can log on to the EMR console to obtain the cluster ID.

DatabaseName String No abc

The name of the database of the EMR cluster. You can call the ListMetaDB operation to query the database name.

TableName String No abc

The name of the table of the EMR cluster. You can call the GetMetaDBTableList operation to query the table name.

DataSourceType String No emr

The type of the data source. Only EMR is supported.

Response parameters

Parameter Type Example Description
Data Struct

The field information of the table.

ColumnList Array of ColumnList

The fields returned.

Caption String data column

The description of the field.

ColumnGuid String odps.engine_name.table_name.name

The GUID of the field.

ColumnName String name

The name of the field.

ColumnType String string

The data type of the field.

Comment String comment

The remarks of the field.

IsForeignKey Boolean true

Indicates whether the field is a foreign key. Valid values:

  • true: The field is a foreign key.
  • false: The field is not a foreign key.
IsPartitionColumn Boolean false

Indicates whether the field is a partition field. Valid values:

  • true: The field is a partition field.
  • false: The field is not a partition field.
IsPrimaryKey Boolean false

Indicates whether the field is the primary key. Valid values:

  • true: The field is the primary key.
  • false: The field is not the primary key.
Position Integer 1

The ordinal number of the field.

PageNum Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page. Default value: 10. Maximum value: 100.

TotalCount Long 100

The total number of fields.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code returned.

ErrorMessage String The connection does not exist.

The error message returned.

HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String 0bc1ec92159376

The ID of the request. You can use the ID to obtain logs and troubleshoot issues.

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

Http status code Error code Error message Description
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the maximum number of requests for the resource has been reached.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the maximum number of requests per day for the resource has been reached.
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 has 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 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.GuidFormat The GUID format is invalid. The error message returned because the GUID format is 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 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.

For more information about the example on how to use the GetMetaTableColumn operation, see Examples of DataWorks API operations.