GetTableInfo - 获取表信息

查看MaxCompute内部表、视图、外部表、聚簇表或Transactional表的信息。

调试

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

授权信息

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

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

请求语法

GET /api/v1/projects/{projectName}/tables/{tableName} HTTP/1.1

请求参数

名称类型必填描述示例值
projectNamestring

待查看表或视图的所属项目名称。

odps_project
schemaNamestring

待查看表或视图的所属 Schema 名称。

default
tableNamestring

待查看表或视图的名称。

sale_detail
typestring

待查看表或视图的类型。取值:

  • internal:内部表。
  • external:外部表。
  • view:视图。
  • materializedView物化视图
internal

返回参数

名称类型描述示例值
object

请求返回参数。

requestIdstring

请求 ID。

0a06dd4516687375802853481ec9fd
dataobject

请求返回结果。

namestring

表或视图名称。

sale_detail
ownerstring

表或视图的所有者账号信息。

ALIYUN$odps****@aliyunid.com
typestring

表或视图类型。取值:

  • internal:内部表。
  • external:外部表。
  • view:视图。
  • materializedView物化视图
internal
schemastring

表或视图的所属 Schema 名称。

default
creationTimelong

创建时间。

2022-01-17T07:07:47Z
viewTextstring

生成视图的语句,当类型为视图时有此返回值。

select shop_name, sum(total_price) from sale_detail group by shop_name
displayNamestring

展示名称。

odps_project.default.sale_detail
projectNamestring

表或视图的所属项目名称。

odps_project
lastDDLTimelong

表或视图的 DDL 最后变更时间。

2023-11-21T02:05:56Z
lastModifiedTimelong

表或视图的数据最后变更时间。

2023-11-21T02:05:56Z
lastAccessTimelong

表或视图的数据最后访问时间,当表为非分区表时有此返回值。

说明 该数据从 2023 年 7 月陆续升级采集,在升级后没有被访问过或者通过 ALGO 作业、Hologres 直读方式访问的无法采集到 last_access_time。
2023-11-21T02:05:56Z
lifecyclestring

生命周期(天)。

-1
isExternalTableboolean

是否为外部表,当类型为表时有此返回值。

false
sizelong

如果表为非分区表,值为表的数据量大小。如果表为分区表,系统不会计算表的数据量大小,值为 NULL。PARTITIONS 视图中包含分区表各个分区的数据量大小。单位:字节(Byte)。

5372
commentstring

表注释。

sale_detail
tableLabelstring

表的敏感等级标签。更多信息请参见 Label 权限控制

0
createTableDDLstring

创建表的 DDL 语句。

create table if not exists sale_detail( shop_name STRING, customer_id STRING, total_price DOUBLE) partitioned by (sale_date STRING, region STRING);
nativeColumnsarray<object>

字段信息。

nativeColumnobject

字段信息。

namestring

列名。

shop_name
typestring

数据类型。

STRING
labelstring

列的敏感等级标签。更多信息请参见 Label 权限控制

0
commentstring

列注释。

商店名称
partitionColumnsarray<object>

分区列信息,分区表才有此返回值。

partitionColumnobject

分区列信息。

namestring

分区名。

ds='20190130'
typestring

数据类型。

STRING
labelstring

列的敏感等级标签。更多信息请参见 Label 权限控制

0
commentstring

分区列注释。

销售日期
materializedViewboolean

是否为物化视图

false
rewriteEnabledboolean

是否允许通过物化视图执行查询改写操作,当类型为物化视图时有此返回值。

false
autoRefreshEnabledboolean

是否开启自动刷新物化视图,当类型为物化视图时有此返回值。

false
isOutdatedboolean

是否因为源表数据有变化,导致物化视图数据无效,当类型为物化视图时有此返回值。

false
physicalSizelong

物理大小。

2763
fileNumlong

文件数量。

200
storageHandlerstring

外部表解析器,当类型为外部表时有此返回值。

com.aliyun.odps.CsvStorageHandler
locationstring

外部表地址,当类型为外部表时有此返回值。

oss://oss-cn-hangzhou-internal.aliyuncs.com/oss-mc-test/Demo1/
odpsPropertiesRolearnstring

RAM 中 AliyunODPSDefaultRole 的 ARN 信息,当类型为外部表时有此返回值。

acs:ram::xxxxx:role/aliyunodpsdefaultrole
tablestoreColumnsMappingstring

描述 MaxCompute 将访问的 Tablestore 表的列,包括主键和属性列,当类型为外部表时有此返回值。

o_orderkey,o_orderdate,o_custkey,o_orderstatus,o_totalprice
tablesotreTableNamestring

需要访问的 Tablestore 表名称,当类型为外部表时有此返回值。

ots_tpch_orders
odpsSqlTextOptionFlushHeaderboolean

是否忽略表头,当类型为外部表时有此返回值。

true
odpsTextOptionHeaderLinesCountlong

忽略表头前 N 行,当类型为外部表时有此返回值。

1
clusterInfoobject

聚簇属性,当表类型为聚簇表时有此返回值。

clusterTypestring

表的聚簇(Clustering)类型,MaxCompute 当前支持Hash ClusteringRange Clustering 两种类型。

Hash
clusterColsarray

聚簇字段(Cluster Key)。

clusterColsstring

聚簇字段(Cluster Key)。

col_1
sortColsarray<object>

排序字段。

sortColsobject

排序字段。

namestring

排序字段名称。

col_2
orderstring

排序方式。

DESC
bucketNumlong

可选字段,Cluster 表的 Bucket 数目,0 表示作业执行时动态决定。

1024

示例

正常返回示例

JSON格式

{
  "requestId": "0a06dd4516687375802853481ec9fd",
  "data": {
    "name": "sale_detail",
    "owner": "ALIYUN$odps****@aliyunid.com",
    "type": "internal",
    "schema": "default",
    "creationTime": 0,
    "viewText": "select shop_name, sum(total_price) from sale_detail group by shop_name",
    "displayName": "odps_project.default.sale_detail",
    "projectName": "odps_project",
    "lastDDLTime": 0,
    "lastModifiedTime": 0,
    "lastAccessTime": 0,
    "lifecycle": "-1",
    "isExternalTable": false,
    "size": 5372,
    "comment": "sale_detail",
    "tableLabel": "0",
    "createTableDDL": "create table if not exists sale_detail( shop_name STRING, customer_id STRING, total_price DOUBLE) partitioned by (sale_date STRING, region STRING);",
    "nativeColumns": [
      {
        "name": "shop_name",
        "type": "STRING",
        "label": "0",
        "comment": "商店名称"
      }
    ],
    "partitionColumns": [
      {
        "name": "ds='20190130'",
        "type": "STRING",
        "label": "0",
        "comment": "销售日期"
      }
    ],
    "materializedView": false,
    "rewriteEnabled": false,
    "autoRefreshEnabled": false,
    "isOutdated": false,
    "physicalSize": 2763,
    "fileNum": 200,
    "storageHandler": "com.aliyun.odps.CsvStorageHandler",
    "location": "oss://oss-cn-hangzhou-internal.aliyuncs.com/oss-mc-test/Demo1/",
    "odpsPropertiesRolearn": "acs:ram::xxxxx:role/aliyunodpsdefaultrole",
    "tablestoreColumnsMapping": "o_orderkey,o_orderdate,o_custkey,o_orderstatus,o_totalprice",
    "tablesotreTableName": "ots_tpch_orders",
    "odpsSqlTextOptionFlushHeader": true,
    "odpsTextOptionHeaderLinesCount": 1,
    "clusterInfo": {
      "clusterType": "Hash",
      "clusterCols": [
        "col_1"
      ],
      "sortCols": [
        {
          "name": "col_2",
          "order": "DESC"
        }
      ],
      "bucketNum": 1024
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-11-05OpenAPI 返回结构发生变更查看变更详情