文档

GetTableInfo - 获取表信息

更新时间:

获取表信息

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

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

请求参数

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

项目名称。

projectA
schemaNamestring

schema 名称。

default
tableNamestring

表名

sale_detail
typestring

表类型。

枚举值:
  • internalinternal
  • externalexternal
  • viewview
  • materialViewmaterialView
internal

返回参数

名称类型描述示例值
object

PopResult

requestIdstring

请求 id。

0a06dd4516687375802853481ec9fd
dataobject

返回数据。

namestring

表名称。

sale_detail
ownerstring

表的拥有者。

188785396123****
typestring

表类型。

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

归属 schema。

default
creationTimelong

创建时间

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

生成视图的语句(当前表类型为视图时展示)。

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

展示名称。

project_name.schema_name.table_name
projectNamestring

项目名称。

projectA
lastDDLTimelong

DDL 最近更新时间。

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

数据最近更新时间。

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

数据最近访问时间。

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

生命周期。

-1
isExternalTableboolean

是否外部表。

false
sizelong

大小。

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

列名。

sale_date
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

示例

正常返回示例

JSON格式

{
  "requestId": "0a06dd4516687375802853481ec9fd",
  "data": {
    "name": "sale_detail",
    "owner": "188785396123****",
    "type": "-**internal**:内部表。\n-**external**:外部表。\n-**view**:视图。\n-**materializedView**:物化视图。",
    "schema": "default",
    "creationTime": 0,
    "viewText": "select shop_name, sum(total_price) from sale_detail group by shop_name",
    "displayName": "project_name.schema_name.table_name",
    "projectName": "projectA",
    "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": "sale_date",
        "type": "STRING",
        "label": "0",
        "comment": "销售日期"
      }
    ],
    "materializedView": false,
    "rewriteEnabled": false,
    "autoRefreshEnabled": false,
    "isOutdated": false,
    "physicalSize": 2763,
    "fileNum": 200,
    "storageHandler": "com.aliyun.odps.CsvStorageHandler",
    "location": "外部表地址\n\noss://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
  }
}

错误码

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

变更历史

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