调用GetMetaTableColumn，获取表的字段信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetMetaTableColumn

要执行的操作。
RegionId String 是 cn-shanghai

地域信息，通常为服务所在的地域。例如，华东2（上海）为cn-shanghai，华北3（张家口）为cn-zhangjiakou。您无需填写RegionId，会根据调用的Endpoint自动解析。
TableGuid String 是 odps.engine_name.table_name

表的唯一标识。您可以通过调用GetMetaDBTableList，获取表的唯一标识。

PageNum Integer 否 1

请求获取的数据页码数，用于翻页。
PageSize Integer 否 10

每页显示的条数，默认为10条，最大100条。
ClusterId String 否 C-010A704DA760****

EMR集群的ID，您可以登录EMR管理控制台，获取集群ID。
DatabaseName String 否 abc

EMR的数据库名称。您可以通过调用ListMetaDB接口，获取数据库名称。

TableName String 否 abc

EMR的表名称。您可以通过调用GetMetaDBTableList接口，获取表名称。

DataSourceType String 否 emr

数据类型，当前仅支持取值为emr。

返回数据

名称 类型 示例值 描述
Data Struct

业务数据。
ColumnList Array of ColumnList

字段的信息。
Caption String data column

字段的描述。
ColumnGuid String odps.engine_name.table_name.name

字段的唯一标识。
ColumnName String name

字段的名称。
ColumnType String string

字段的类型。
Comment String comment

字段的备注。
IsForeignKey Boolean true

字段是否为外键，取值如下：

  • true，是外键。
  • false，不是外键。
IsPartitionColumn Boolean false

字段是否为分区字段，取值如下：

  • true，是分区字段。
  • false，不是分区字段。
IsPrimaryKey Boolean false

字段是否为主键，取值如下：

  • true，是主键。
  • false，不是主键。
Position Integer 1

字段的排序。
PageNum Integer 1

请求获取的数据页码数，用于翻页。
PageSize Integer 10

每页显示的条数，默认为10条，最大100条。
TotalCount Long 100

字段的总数。
ErrorCode String Invalid.Tenant.ConnectionNotExists

错误码。
ErrorMessage String The connection does not exist.

错误信息。
HttpStatusCode Integer 200

HTTP状态码。
RequestId String 0bc1ec92159376

请求ID。用于定位日志，排查问题。
Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=GetMetaTableColumn
&RegionId=cn-shanghai
&TableGuid=odps.engine_name.table_name
&<公共请求参数>

正常返回示例

XML格式 

<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格式 

{
    "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
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误，请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误，请稍后再试。
429 Throttling.Api The request for this resource has exceeded your available limit. 对该资源的请求已超过您的可用上限。
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. 对该资源的请求已超过您的每日可用上限。
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks系统繁忙，请稍后再试。
429 Throttling.User Your request is too frequent. Try again later. 您的请求过于频繁，请尝试放缓请求速度。
403 Forbidden.Meta.NoTenant The user is not the owner of any tenants. 当前的用户不是任何租户的所有者。
500 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. 根据ODPS项目{0}获取计算引擎失败。
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. 接口网络不通。
500 InternalError.Meta.Unknown An unknown error occurred while processing your request. 未知错误。
400 InvalidParameter.Meta.CommonError The specified parameter is invalid. 请求参数错误。
400 InvalidParameter.Meta.GuidFormat The GUID format is invalid. Guid信息错误。
400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. App参数错误。
400 InvalidParameter.Meta.IllegalDate The date format is invalid. 日期格式错误。
400 InvalidParameter.Meta.IllegalPageError The parameter for paging is invalid. 分页信息错误。
400 InvalidParameter.Meta.NotExist The object does not exist. 数据不存在。
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 您被限制访问，请开通DataWorks企业版或旗舰版。

访问错误中心查看更多错误码。

GetMetaTableColumn接口的使用示例Demo请参见DataWorks OpenAPI示例。