GetMetaTableColumn - API| Alibaba Cloud Documentation Center

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	GetMetaTableColumn	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 returned page.
PageSize	Integer	No	10	The number of records per page.
ClusterId	String	No	abc	The id of the emr cluster. For emr query status
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.
ColumnList	Array of ColumnList		The field information.
Caption	String	data column	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	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 the page to return.
PageSize	Integer	10	The size of each page in the paged query.
TotalCount	Long	100	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	0bc1ec92159376****	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=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>1</ColumnName>
        <Comment>comment </Comment>
        <ColumnGuid>odps.engine_name.table_name.1</ColumnGuid>
        <ColumnType>string</ColumnType>
        <IsPartitionColumn>false</IsPartitionColumn>
        <IsForeignKey>true</IsForeignKey>
        <Caption>data column</Caption>
        <IsPrimaryKey>false</IsPrimaryKey>
    </ColumnList>
</Data>
<ErrorCode>success</ErrorCode>
<ErrorMessage>success</ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "0bc1ec92159376****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": "100",
        "PageNum": "1",
        "PageSize": "10",
        "ColumnList": {
            "ColumnName": "1",
            "Comment": "comment ",
            "ColumnGuid": "odps.engine_name.table_name.1",
            "ColumnType": "string",
            "IsPartitionColumn": "false",
            "IsForeignKey": "true",
            "Caption": "data column",
            "IsPrimaryKey": "false"
        }
    },
    "ErrorCode": "success",
    "ErrorMessage": "success",
    "Success": true
}

Error codes


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