全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：GetMetaTableBasicInfo - 获取表的基础信息

    文档中心

    大数据开发治理平台 DataWorks：GetMetaTableBasicInfo - 获取表的基础信息

    更新时间：Nov 21, 2024

    该接口用于获取表的基础信息。

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dataworks:*get
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    TableGuidstring是

    MaxCompute 表的唯一标识。格式为 odps.projectName.tableName。

    说明 EMR 场景下，该参数非必选。
    		odps.engine_name.table_name
    ClusterIdstring否

    EMR 集群的 ID，当 DataSourceType（数据类型）参数配置为 EMR 时，当前参数必配。

    您可以登录 EMR 的控制台，获取集群 ID。

    		abc
    DatabaseNamestring否

    数据库的名称。仅当数据类型为 EMR 时，需要配置该参数。

    您可以调用 ListMetaDB 接口获取。

    		abc
    TableNamestring否

    EMR 的表名称。仅当数据类型为 EMR 时，需要配置该参数。

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

    		abc
    DataSourceTypestring否

    数据类型，包括 odps 和 emr。

    		emr
    Extensionboolean否

    是否包含扩展字段。 扩展字段包含读取次数、收藏次数、浏览次数等。 仅当数据类型为 ODPS 时，该参数生效。

    		false

    返回参数

    名称类型描述示例值
    object

    返回结果。

    HttpStatusCodeinteger

    请求返回码。

    		200
    ErrorMessagestring

    错误信息。

    		The connection does not exist.
    RequestIdstring

    请求 ID。

    		0bc1411515937
    Successboolean

    请求是否成功。

    		true
    ErrorCodestring

    错误码。

    		Invalid.Tenant.ConnectionNotExists
    Dataobject

    业务数据。

    TableNamestring

    表的名称。

    		table_name
    FavoriteCountlong

    表的收藏次数。仅当 Extension 参数取值为 true 时才会返回该参数，并且该参数仅对 odps 数据类型生效。

    		6
    Commentstring

    表的描述。

    		test table
    ColumnCountinteger

    字段的个数。

    		3
    CreateTimelong

    创建表的时间。

    		1589870294000
    ProjectIdlong

    工作空间的 ID。

    		232
    OwnerIdstring

    表所有者的 ID。

    		123
    EnvTypeinteger

    环境类型，取值如下：

    • 0 表示开发表。
    • 1 表示生产表。
    		1
    DatabaseNamestring

    数据库的名称。

    		abc
    IsVisibleinteger

    表的可见性：

    • 0 表示目标表对工作空间成员可见。
    • 1 表示目标表对租户内成员可见。
    • 2 表示目标表对租户间成员均可见。
    • 3 表示目标表仅对责任人可见。
    		1
    TableGuidstring

    表的唯一标识。

    		odps.engine_name.table_name
    ReadCountlong

    表的读取次数。仅当 Extension 参数取值为 true 时才会返回该参数，并且该参数仅对 odps 数据类型生效。

    		3
    ClusterIdstring

    EMR 集群的 ID。

    		abc
    IsPartitionTableboolean

    是否为分区表，取值如下：

    • true：是分区表。
    • false：不是分区表。
    		true
    IsViewboolean

    是否为视图，取值如下：

    • true：是视图。
    • false：不是视图。
    		false
    LifeCycleinteger

    表的生命周期。单位为天。

    		5
    ProjectNamestring

    工作空间的名称。

    		test
    ViewCountlong

    表的浏览次数。仅当 Extension 参数取值为 true 时才会返回该参数，并且该参数仅对 odps 数据类型生效。

    		2
    LastAccessTimelong

    最近一次访问表的时间。

    		1589870294000
    DataSizelong

    表占用的存储空间。单位为 Byte。

    		10
    LastModifyTimelong

    最近一次更新表的时间。

    		1589870294000
    LastDdlTimelong

    最近一次变更表结构的时间。

    		1589870294000
    PartitionKeysstring

    Hive 分区。

    		ab
    Locationstring

    Hive 数据库的存储地址。

    		hdfs://
    Captionstring

    表的中文名称。

    		中文名
    TenantIdlong

    租户 ID。

    		12345
    Schemastring

    表 Schema 信息。在 ODPS，用户启动了三层模型需要填写 Schema 信息

    		default

    示例

    正常返回示例

    JSON格式

    {
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1411515937",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "TableName": "table_name",
    "FavoriteCount": 6,
    "Comment": "test table",
    "ColumnCount": 3,
    "CreateTime": 1589870294000,
    "ProjectId": 232,
    "OwnerId": "123",
    "EnvType": 1,
    "DatabaseName": "abc",
    "IsVisible": 1,
    "TableGuid": "odps.engine_name.table_name",
    "ReadCount": 3,
    "ClusterId": "abc",
    "IsPartitionTable": true,
    "IsView": false,
    "LifeCycle": 5,
    "ProjectName": "test",
    "ViewCount": 2,
    "LastAccessTime": 1589870294000,
    "DataSize": 10,
    "LastModifyTime": 1589870294000,
    "LastDdlTime": 1589870294000,
    "PartitionKeys": "ab",
    "Location": "hdfs://",
    "Caption": "中文名",
    "TenantId": 12345,
    "Schema": "default"
  }
}

    错误码

    HTTP status code错误码错误信息描述
    400Invalid.Meta.TableNotExistThe table does not exist.表不存在。
    400InvalidParameter.Meta.CommonErrorThe specified parameter is invalid.请求参数错误。
    400InvalidParameter.Meta.IllegalThe app guid parameter is invalid.App参数错误。
    400InvalidParameter.Meta.IllegalDateThe date format is invalid.日期格式错误。
    400InvalidParameter.Meta.IllegalPageErrorThe parameter for paging is invalid.分页信息错误。
    400InvalidParameter.Meta.NotExistThe object does not exist.-
    400InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误，请稍后再试。
    400InternalError.Meta.NoCalcEngineAn error occurred while retrieving the compute engine based on the MaxCompute project.用户输入的 project 不正确
    403Forbidden.Meta.NoTenantThe user is not the owner of any tenants.当前的用户不是任何租户的所有者。
    403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限，请授权
    429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
    429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.对该资源的请求已超过您的每日可用上限。
    429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙，请稍后再试。
    429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁，请尝试放缓请求速度。
    500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误，请稍后再试。
    500InternalError.Meta.TenantTimeOutFailed to connect to the interface network.接口网络不通。
    500InternalError.Meta.UnknownAn unknown error occurred while processing your request.未知错误。

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史

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