文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ LakeCat类API/ 数据表管理/ 根据条件分页列举表信息 - ListTables
更新时间：2026-08-31 GMT+08:00
查看PDF
分享

根据条件分页列举表信息 - ListTables

功能介绍

返回数据库下符合查询条件的表的元数据信息，不支持事务操作。

当表名通配符或表类型不为空时，优先根据表名和类型筛选过滤。

当表名通配符或表类型为空时，再根据属性筛选过滤。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/tables

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目编号。获取方法，请参见获取项目ID。

约束限制:

长度为1~64个字符

取值范围:

长度为1~64个字符

默认取值:

不涉及

instance_id

是

String

参数解释:

LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

catalog_name

是

String

参数解释:

catalog名称。

约束限制:

只能包含字母、数字和下划线，且长度为1~256个字符。

取值范围:

长度为1~256个字符

默认取值:

不涉及

database_name

是

String

参数解释:

数据库名称。

约束限制:

只能包含中文、字母、数字、下划线、中划线，且长度为1~128个字符。

取值范围:

长度为1~128个字符

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

table_name_pattern

否

String

参数解释:

表名称通配符。

约束限制:

只能包含中文、字母、数字和_|*.-特殊字符，且长度为1~256个字符。

取值范围:

长度为1~256个字符

默认取值:

不涉及

table_format

否

String

参数解释:

表格式。支持HIVE,ICEBERG,LANCE

约束限制:

可选值为：HIVE, ICEBERG, LANCE

取值范围:

不涉及

默认取值:

不涉及

table_type

否

String

参数解释:

表类型：MANAGED_TABLE-内表、EXTERNAL_TABLE-外表、VIRTUAL_VIEW-视图、MATERIALIZED_VIEW-物化视图、DICTIONARY_TABLE字典表、LAKE_TABLE内表，LAKE_MATERIALIZED_VIEW-内部物化视图

约束限制:

可选值为：MANAGED_TABLE, EXTERNAL_TABLE, VIRTUAL_VIEW, MATERIALIZED_VIEW, DICTIONARY_TABLE, LAKE_TABLE, LAKE_MATERIALIZED_VIEW

取值范围:

不涉及

默认取值:

不涉及

filter

否

String

参数解释:

过滤条件字符串，可以按照属性查询表。

约束限制:

长度为0~1000个字符

取值范围:

长度为0~1000个字符

HIVE_FILTER_FIELD_OWNER

HIVE_FILTER_FIELD_LAST_ACCESS

HIVE_FILTER_FIELD_PARAMS

默认取值:

不涉及

limit

否

Integer

参数解释:

查询返回条数。

约束限制:

取值为1~5000

取值范围:

取值为1~5000

默认取值:

100

marker

否

String

参数解释:

查询的起始记录ID。

约束限制:

长度为0~1024个字符

取值范围:

长度为0~1024个字符

默认取值:

不涉及

reverse_page

否

Boolean

参数解释:

是否倒序查询。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

false

deleted

否

Boolean

参数解释:

是否查询被删除元数据。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

false

include_fields

否

String

参数解释:

包含字段，非必填，多个字段使用英文逗号分隔，不填时返回全部字段，当前暂只支持name

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

Array of strings

参数解释:

租户token。

约束限制:

数组元素个数为1~100

取值范围:

数组元素个数为1~100

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

tables

Array of Table objects

参数解释:

表信息

page_info

PagedInfo object

参数解释:

分页信息
表5 Table

参数

参数类型

描述

catalog_name

String

参数解释:

catalog名称

catalog_id

String

参数解释:

catalogID

database_name

String

参数解释:

数据库名称

database_id

String

参数解释:

数据库ID

table_name

String

参数解释:

表名称

table_id

String

参数解释:

表ID

table_status

Integer

参数解释:

表状态，0表示正常，1表示删除中，2表示已删除，3表示恢复中，4表示清除中

external_table_id

String

参数解释:

用户端表id，创建时指定，不可修改

create_time

String

参数解释:

表创建时间

last_access_time

String

参数解释:

最后访问时间

update_time

String

参数解释:

表元数据最后一次修改时间

last_analyzed_time

String

参数解释:

上一次做列级别的统计信息计算的时间

owner

String

参数解释:

用户信息

owner_type

String

参数解释:

用户类型，USER-用户，GROUP-组，ROLE-角色

parameters

Map<String,String>

参数解释:

参数

partition_keys

Array of Column objects

参数解释:

表分区列的列表

retention

Integer

参数解释:

表保留时间

storage_descriptor

StorageDescriptor object

参数解释:

数据存储

table_format

String

参数解释:

表格式。支持{HIVE,ICEBERG,LANCE}，默认值为HIVE

table_type

String

参数解释:

表类型，MANAGED_TABLE-内表，EXTERNAL_TABLE-外表，VIRTUAL_VIEW-视图，MATERIALIZED_VIEW-物化视图，DICTIONARY_TABLE字典表，LAKE_TABLE内表，LAKE_MATERIALIZED_VIEW-内部物化视图

comments

String

参数解释:

表描述信息

view_expanded_text

String

参数解释:

如果表是视图，则为视图的扩展文本

view_original_text

String

参数解释:

如果表是视图，则为视图的原始文本

data_statistic_enable

Boolean

参数解释:

数据概况统计开关。默认状态为开，修改table开关状态后，还需检查所属database的开关状态。例如：table与所属database开关同时打开，则数据概况统计开启。否则关闭

version_id

String

参数解释:

版本ID
表6 StorageDescriptor

参数

参数类型

描述

columns

Array of Column objects

参数解释:

分区列以外的所有字段

取值范围:

数组元素个数为0~10000

location

String

参数解释:

路径地址。例如obs://location/uri/

取值范围:

最大长度为4000

compressed

Boolean

参数解释:

是否启用数据压缩。默认为false

取值范围:

不涉及

input_format

String

参数解释:

输入格式

取值范围:

长度为0~128个字符

output_format

String

参数解释:

输出格式

取值范围:

长度为0~128个字符

number_of_buckets

Integer

参数解释:

分桶的桶数量。默认值为0

取值范围:

取值为-1~2147483647

bucket_columns

Array of strings

参数解释:

分桶字段

取值范围:

长度为1~255个字符，数组元素个数为0~200

sort_columns

Array of Order objects

参数解释:

指定表中的每个存储桶的排序顺序的列表

取值范围:

数组元素个数为0~10000

serde_info

SerDeInfo object

参数解释:

序列化/反序列化信息

取值范围:

不涉及

parameters

Map<String,String>

参数解释:

存储描述符的参数，键和值为字符串，长度不超过100000

取值范围:

长度为0~100000个字符

skewed_info

SkewedInfo object

参数解释:

有关在列中经常出现的值（偏斜值）的信息

取值范围:

不涉及

stored_as_sub_directories

Boolean

参数解释:

数据是否会存放在子目录中

取值范围:

不涉及
表7 Column

参数

参数类型

描述

column_type

String

参数解释:

列类型。

取值范围:

长度为1~65535个字符

column_name

String

参数解释:

列名称。只能包含中文、字母、数字和_-+*(), 特殊字符，且长度为1~767个字符

取值范围:

长度为1~767个字符

comment

String

参数解释:

列描述信息。最大长度为4000个字符

取值范围:

长度为0~4000个字符

advance_column_type

String

参数解释:

用户自定义类型名称，当且仅当column_type为struct，字段可填写。该字段存在值时，表示用户自定义的高阶类型

取值范围:

长度为0~64个字符
表8 Order

参数

参数类型

描述

column

String

参数解释:

列名称。只能包含中文、字母、数字和_-+*(), 特殊字符，且长度为1~767个字符

取值范围:

长度为1~767个字符

sort_order

Integer

参数解释:

指示是按升序 (== 1) 还是降序 (==0) 对列进行排序

取值范围:

取值为0~1
表9 SerDeInfo

参数

参数类型

描述

name

String

参数解释:

名称信息

取值范围:

长度为0~256个字符

serialization_library

String

参数解释:

实现序列化/反序列化的类

取值范围:

长度为0~256个字符

parameters

Map<String,String>

参数解释:

参数数组，键和值为字符串，长度不超过100000

取值范围:

长度为0~100000个字符
表10 SkewedInfo

参数

参数类型

描述

skewed_column_names

Array of strings

参数解释:

数据偏移列的列表

取值范围:

长度为1~256个字符，数组元素个数为0~100000

skewed_column_value_location_maps

Map<String,String>

参数解释:

偏斜值和地址的映射关系

取值范围:

长度为0~65534个字符

skewed_column_values

Array<Array<String>>

参数解释:

偏斜值的列表

取值范围:

长度为0~65534个字符，数组元素个数为0~100000
表11 PagedInfo

参数

参数类型

描述

current_count

Integer

参数解释:

本次返回的对象个数。最小值为0，最大值为2000

next_marker

String

参数解释:

下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数

previous_marker

String

参数解释:

上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数

状态码：400

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

solution_msg

String

参数解释:

解决方案描述

状态码：401

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

solution_msg

String

参数解释:

解决方案描述

状态码：403

表14 响应Body参数

参数

参数类型

描述

error

Error object

参数解释:

错误信息

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

title

String

参数解释:

标题
表15 Error

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

title

String

参数解释:

标题

message

String

参数解释:

错误信息

code

String

参数解释:

状态码

状态码：404

表16 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

solution_msg

String

参数解释:

解决方案描述

状态码：408

表17 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

solution_msg

String

参数解释:

解决方案描述

状态码：500

表18 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

solution_msg

String

参数解释:

解决方案描述

请求示例

GET https://{endpoint} /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/tables

响应示例

状态码：200

OK

{
  "tables" : [ {
    "catalog_name" : "hive",
    "database_name" : "dba",
    "table_name" : "www",
    "create_time" : "2022-11-19T03:10:14.000+00:00",
    "last_access_time" : "2022-12-31T23:59:59.000+00:00",
    "update_time" : null,
    "last_analyzed_time" : null,
    "owner" : "lakeformation",
    "owner_type" : "USER",
    "parameters" : {
      "ww" : "ww",
      "transient_lastDdlTime" : "1668827414",
      "classification" : "avro",
      "www" : "ww",
      "wwww" : "ww"
    },
    "partition_keys" : [ ],
    "retention" : 0,
    "storage_descriptor" : {
      "columns" : [ {
        "column_type" : "tinyint",
        "column_name" : "ww",
        "comment" : null
      } ],
      "location" : "obs://lakeformation/test",
      "compressed" : true,
      "input_format" : "org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat",
      "output_format" : "org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat",
      "number_of_buckets" : 0,
      "bucket_columns" : [ ],
      "sort_columns" : [ ],
      "serde_info" : {
        "name" : "name",
        "serialization_library" : "org.apache.hadoop.hive.serde2.avro.AvroSerDe",
        "parameters" : {
          "serialization.format" : "1"
        }
      },
      "parameters" : { },
      "skewed_info" : {
        "skewed_column_names" : [ ],
        "skewed_column_value_location_maps" : { },
        "skewed_column_values" : [ ]
      },
      "stored_as_sub_directories" : false
    },
    "table_format" : "HIVE",
    "table_type" : "MANAGED_TABLE",
    "comments" : "",
    "view_expanded_text" : "",
    "view_original_text" : ""
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : null,
    "previous_marker" : null
  }
}

状态码：400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码。

父主题： 数据表管理

相关文档