文档

ListTables - 获取表列表

更新时间:

获取MaxCompute项目内的表列表。

调试

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

授权信息

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

请求语法

GET /api/v1/projects/{projectName}/tables

请求参数

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

MaxCompute 项目名称。

projectA
prefixstring

限定返回的资源名称,名称必须以 Prefix 作为前缀,例如 Prefix 是 a,则返回的资源名均是以 a 开始的。

a
markerstring

设定结果从 marker 之后按字母排序的第一个开始返回。

Y29tbWlzc2lvbl9leHRlcm5hbF91cmdlXzFfd3Ih
maxIteminteger

每页返回的最大结果数。

10
typestring

表类型。

枚举值:
  • internalinternal
  • externalexternal
internal
schemaNamestring

Schema 名称。

default

返回参数

名称类型描述示例值
object

PopResult<ListResultDTO<TableInfo, MarkerPageInfo>>

requestIdstring

请求 ID。

0a06dd4516687375802853481ec9fd
dataobject

返回数据。

tablesobject []

表信息。

namestring

表名称。

sale_detail
ownerstring

表所有者。

188785396123****
typestring

表类型。

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

展示名称。

sale_detail
projectNamestring

项目名称。

projectA
lastDDLTimelong

DDL 最近更新时间。

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

数据最近更新时间。

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

数据最近访问时间。

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

生命周期。

-1
isExternalTableboolean

是否外部表。

False
sizelong

大小。

5372
tableCommentstring

表说明。

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);
nativeColumnsobject []

列信息。

namestring

列名。

shop_name
typestring

类型。

STRING
labelstring

列 Label 等级。

0
commentstring

备注。

商店名称
partitionColumnsobject []

分区列信息。

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
markerstring

设定结果从 marker 之后按字母排序的第一个开始返回。

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxIteminteger

每页返回的最大结果数。

10

示例

正常返回示例

JSON格式

{
  "requestId": "0a06dd4516687375802853481ec9fd",
  "data": {
    "tables": [
      {
        "name": "sale_detail",
        "owner": "188785396123****",
        "type": "internal\n",
        "schema": "default",
        "creationTime": 0,
        "viewText": "select shop_name, sum(total_price) \nfrom sale_detail group by shop_name",
        "displayName": "sale_detail",
        "projectName": "projectA\n",
        "lastDDLTime": 0,
        "lastModifiedTime": 0,
        "lastAccessTime": 0,
        "lifecycle": "-1",
        "isExternalTable": true,
        "size": 5372,
        "tableComment": "sale_detail",
        "tableLabel": "0",
        "createTableDDL": "create table if not exists sale_detail(\n shop_name     STRING,\n customer_id   STRING,\n total_price   DOUBLE)\npartitioned 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": "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
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-14OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:schemaName
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈