调用GetMetaTableFullInfo获取表的完整信息(包括字段信息)。

调试

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

请求参数

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

要执行的操作。

RegionId String cn-shanghai

地域ID。

TableGuid String odps.engine_name.table_name

表的唯一标识。

PageNum Integer 1

分页查询页码。

PageSize Integer 10

分页查询每页的大小。

ClusterId String abc

emr集群id。针对emr情况

DatabaseName String abc

数据库名称

TableName String abc

表名称

DataSourceType String emr

数据类型。odps或者emr

返回数据

名称 类型 示例值 描述
Data Struct

业务数据。

ClusterId String abc

emr集群id

ColumnList Array of ColumnList

字段列表。

Caption String data comment

字段的描述信息。

ColumnGuid String odps.engine_name.table_name.1

字段的唯一标识。

ColumnName String 1

字段的名称。

ColumnType String string

字段的类型。

Comment String comment

字段的备注。

IsForeignKey Boolean true

是否为外键。

IsPartitionColumn Boolean true

是否为分区字段。

IsPrimaryKey Boolean false

是否为主键。

Comment String comment

表的备注信息。

CreateTime Long 1589870293000

创建表的时间。

DataSize Long 10

表占用的存储空间。

DatabaseName String abc

数据库名称

EnvType Integer 1

环境类型:0表示开发表,1表示生产表。

IsVisible Integer 1

可见性:0表示工作空间成员可见,1表示租户内可见,2表示租户间可见,3表示责任人可见。

LastAccessTime Long 1589870294000

最后访问的时间。

LastDdlTime Long 1589870294000

最后变更表结构的时间。

LastModifyTime Long 1589870294000

最后更新表的时间。

LifeCycle Integer 5

表的生命周期。

Location String hdfs://

hive表存储地址

OwnerId String 123

表所有者的ID。

PartitionKeys String abc

分区健

ProjectId Long 22

工作空间的ID。

ProjectName String test

工作空间的名称。

TableGuid String odps.engine_name.table_name

表的唯一标识。

TableName String table_name

表的名称。

TenantId Long 12345

租户ID。

TotalColumnCount Long 22

字段的总数。

ErrorCode String success

错误码。

ErrorMessage String success

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0bc1411515937****

请求ID。

Success Boolean true

请求是否成功。

示例

请求示例

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

正常返回示例

XML 格式

<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>success</ErrorCode>
<ErrorMessage>success</ErrorMessage>
<Success>true</Success>

JSON 格式

{"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":"success","ErrorMessage":"success","Success":"true"}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Activate DataWorks first. 您被限制访问,可能是由于您还未激活DataWorks。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
403 ResourceNotAuthorized.Api You are not authorized to access the resources. 您无法访问未取得授权的资源。
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. 数据不存在。

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