# 分页获取表的描述信息 - ListTableMeta #### 功能介绍 通过数据库通配符和表通配符，找到符合条件的表并返回表的描述信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/LakeFormation/doc?api=ListTableMeta)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lakeformation/abcd.html)。 #### URI GET /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/tables 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释:** 项目编号。获取方法，请参见[获取项目ID](https://support.huaweicloud.com/api-lakeformation/lakeformation_04_0026.html)。 **约束限制:** 长度为1\~64个字符 **取值范围:** 长度为1\~64个字符 **默认取值:** 不涉及 | | instance_id | 是 | String | **参数解释:** LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | | catalog_name | 是 | String | **参数解释:** catalog名称。 **约束限制:** 只能包含字母、数字和下划线，且长度为1\~256个字符。 **取值范围:** 长度为1\~256个字符 **默认取值:** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | database_name_pattern | 否 | String | **参数解释:** 数据库名称通配符。 **约束限制:** 只能包含中文、字母、数字和_\|\*.-特殊字符，且长度为1\~128个字符。 **取值范围:** 长度为1\~128个字符 **默认取值:** 不涉及 | | table_name_pattern | 否 | String | **参数解释:** 表名称通配符。 **约束限制:** 只能包含中文、字母、数字和_\|\*.-特殊字符，且最大长度为1\~256个字符。 **取值范围:** 长度为1\~256个字符 **默认取值:** 不涉及 | | table_types | 否 | Array of strings | **参数解释:** 查询的表类型：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，数组元素个数为0\~4 **取值范围:** 数组元素个数为0\~4 **默认取值:** 不涉及 | | limit | 否 | Integer | **参数解释:** 查询返回条数。 **约束限制:** 取值为1\~2000 **取值范围:** 取值为1\~2000 **默认取值:** 1000 | | marker | 否 | String | **参数解释:** 查询的起始记录ID。 **约束限制:** 长度为0\~256个字符 **取值范围:** 长度为0\~256个字符 **默认取值:** 不涉及 | | reverse_page | 否 | Boolean | **参数解释:** 是否倒序查询。 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** false | | external_table_id | 否 | String | **参数解释:** 用户端表id，创建时指定，不可修改。 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | Array of strings | **参数解释:** 租户token。 **约束限制:** 数组元素个数为1\~100 **取值范围:** 数组元素个数为1\~100 **默认取值:** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | table_metas | Array of [TableMeta] objects | **参数解释:** 表元数据列表 | | page_info | [PagedInfo] object | 分页返回信息。 | 表5TableMeta | 参数 | 参数类型 | 描述 | |:---|:---|:---| | catalog_name | String | **参数解释:** catalog名称 | | database_name | String | **参数解释:** 数据库名称 | | table_name | String | **参数解释:** 表名称 | | external_table_id | String | **参数解释:** 用户端表id，创建时指定，不可修改 | | table_type | String | **参数解释:** 表类型：MANAGED_TABLE-内表、EXTERNAL_TABLE-外表、VIRTUAL_VIEW-视图、MATERIALIZED_VIEW-物化视图、DICTIONARY_TABLE字典表，LAKE_TABLE内表，LAKE_MATERIALIZED_VIEW-内部物化视图 | | comments | String | **参数解释:** 表描述信息 | | columns | Array of [Column] objects | **参数解释:** 分区列以外的所有字段 | | partition_keys | Array of [Column] objects | **参数解释:** 分区列的信息 | 表6Column | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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个字符 | 表7PagedInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | current_count | Integer | **参数解释:** 本次返回的对象个数。最小值为0，最大值为2000 | | next_marker | String | **参数解释:** 下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数 | | previous_marker | String | **参数解释:** 上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释:** 错误信息 | | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | title | String | **参数解释:** 标题 | 表11Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | title | String | **参数解释:** 标题 | | message | String | **参数解释:** 错误信息 | | code | String | **参数解释:** 状态码 | **状态码：404** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：408** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：500** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | solution_msg | String | **参数解释:** 解决方案描述 | #### 请求示例 ``` GET https://{endpoint} /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/tables ``` #### 响应示例 **状态码：200** OK ``` { "table_metas" : [ { "catalog_name" : "hive", "database_name" : "default", "table_name" : "tbla", "table_type" : "MANAGED_TABLE", "comments" : "" }, { "catalog_name" : "hive", "database_name" : "default", "table_name" : "tblb", "table_type" : "MANAGED_TABLE", "comments" : "" } ], "page_info" : { "current_count" : 2, "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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lakeformation/ErrorCode.html)。