# 列举分区信息 - ListPartitions #### 功能介绍 遍历指定数据表下的分区列表，对于事务表，支持基于表的特定版本遍历分区列表。 当过滤条件不为空时，优先根据过滤条件筛选过滤， 当过滤条件为空且分区值不为空时，再根据分区值筛选过滤， 当过滤条件和分区值都为空时，返回指定数据表下所有分区。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/LakeFormation/doc?api=ListPartitions)中调试该接口，支持自动认证鉴权。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/{database_name}/tables/{table_name}/partitions 表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个字符 **默认取值:** 不涉及 | | database_name | 是 | String | **参数解释:** 数据库名称。 **约束限制:** 只能包含中文、字母、数字、下划线、中划线，且长度为1\~128个字符。 **取值范围:** 长度为1\~128个字符 **默认取值:** 不涉及 | | table_name | 是 | String | **参数解释:** 表名称。 **约束限制:** 只能包含中文、字母、数字、下划线、中划线，且长度为1\~256个字符。 **取值范围:** 长度为1\~256个字符 **默认取值:** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | filter | 否 | String | **参数解释:** 分区过滤条件。 **约束限制:** 长度为0\~1000个字符 **取值范围:** 长度为0\~1000个字符 **默认取值:** 不涉及 | | partition_values | 否 | Array of strings | **参数解释:** 分区的值列表。 **约束限制:** 最大长度为256，数组元素个数为0\~1000 **取值范围:** 最大长度为256，数组元素个数为0\~1000 **默认取值:** 不涉及 | | limit | 否 | Integer | **参数解释:** 查询返回条数。 **约束限制:** 取值为1\~1000 **取值范围:** 取值为1\~1000 **默认取值:** 500 | | marker | 否 | String | **参数解释:** 查询的起始记录ID。 **约束限制:** 长度为0\~256个字符 **取值范围:** 长度为0\~256个字符 **默认取值:** 不涉及 | | reverse_page | 否 | Boolean | **参数解释:** 是否倒序查询。 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** false | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | Array of strings | **参数解释:** 租户token。 **约束限制:** 数组元素个数为1\~100 **取值范围:** 数组元素个数为1\~100 **默认取值:** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | partitions | Array of [Partition] objects | **参数解释:** 分区信息 | | page_info | [PagedInfo] object | **参数解释:** 分页信息 | 表5Partition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | catalog_name | String | **参数解释:** catalog名称 | | catalog_id | String | **参数解释:** catalogID | | database_name | String | **参数解释:** 数据库名称 | | database_id | String | **参数解释:** 数据库ID | | table_name | String | **参数解释:** 表名称 | | table_id | String | **参数解释:** 表ID | | partition_id | String | **参数解释:** 分区ID | | partition_values | Array of strings | **参数解释:** 分区值的列表 | | create_time | String | **参数解释:** 创建时间 | | update_time | String | **参数解释:** 更新时间 | | last_access_time | String | **参数解释:** 最后访问时间 | | parameters | Map\ | **参数解释:** 参数表 | | storage_descriptor | [StorageDescriptor] object | **参数解释:** 数据存储 | 表6StorageDescriptor | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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\ | **参数解释:** 存储描述符的参数，键和值为字符串，长度不超过100000 **取值范围:** 长度为0\~100000个字符 | | skewed_info | [SkewedInfo] object | **参数解释:** 有关在列中经常出现的值（偏斜值）的信息 **取值范围:** 不涉及 | | stored_as_sub_directories | Boolean | **参数解释:** 数据是否会存放在子目录中 **取值范围:** 不涉及 | 表7Column | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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个字符 | 表8Order | 参数 | 参数类型 | 描述 | |:---|:---|:---| | column | String | **参数解释:** 列名称。只能包含中文、字母、数字和_-+\*(), 特殊字符，且长度为1\~767个字符 **取值范围:** 长度为1\~767个字符 | | sort_order | Integer | **参数解释:** 指示是按升序 (== 1) 还是降序 (==0) 对列进行排序 **取值范围:** 取值为0\~1 | 表9SerDeInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释:** 名称信息 **取值范围:** 长度为0\~256个字符 | | serialization_library | String | **参数解释:** 实现序列化/反序列化的类 **取值范围:** 长度为0\~256个字符 | | parameters | Map\ | **参数解释:** 参数数组，键和值为字符串，长度不超过100000 **取值范围:** 长度为0\~100000个字符 | 表10SkewedInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | skewed_column_names | Array of strings | **参数解释:** 数据偏移列的列表 **取值范围:** 长度为1\~256个字符，数组元素个数为0\~100000 | | skewed_column_value_location_maps | Map\ | **参数解释:** 偏斜值和地址的映射关系 **取值范围:** 长度为0\~65534个字符 | | skewed_column_values | Array\\> | **参数解释:** 偏斜值的列表 **取值范围:** 长度为0\~65534个字符，数组元素个数为0\~100000 | 表11PagedInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释:** 标题 | 表15Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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/{table_name}/partitions ``` #### 响应示例 **状态码：200** OK ``` { "partitions" : [ { "catalog_name" : "cat97bc31536be24f2cae8ecddf34a6d53a", "database_name" : "dbe062bd53192249d7a0258062ed122683", "table_name" : "tble25e30cecd1a4ab58ab3eba7c70b7dc2", "partition_values" : [ "0e3af7a7552d4aa7b75f271505495590", "936b465a11b64e28aa2d047e92908707" ], "create_time" : "2023-05-30T12:24:30.401+00:00", "last_access_time" : "2023-05-30T12:24:30.000+00:00", "parameters" : { "key1" : "value1", "transient_lastDdlTime" : "120", "classification" : "other" }, "storage_descriptor" : { "columns" : [ { "column_type" : "string", "column_name" : "column_prefix0", "comment" : "b2489a84845b436d8557b2a7ae44082b" }, { "column_type" : "string", "column_name" : "column_prefix1", "comment" : "f6b3ce66332e475f99aaba1c5ba8a080" }, { "column_type" : "string", "column_name" : "column_prefix2", "comment" : "9cd48faa87e04cf0b64416d9491a0131" }, { "column_type" : "string", "column_name" : "column_prefix3", "comment" : "73b0ebce76fe4b5fa97ba29e93f69093" }, { "column_type" : "string", "column_name" : "column_prefix4", "comment" : "9339b5d828314da09900d647a4dcafe2" }, { "column_type" : "string", "column_name" : "column_prefix5", "comment" : "006d9b8151ca4816bc47ba3e53428b7b" }, { "column_type" : "string", "column_name" : "column_prefix6", "comment" : "116e112b2e8c447e942ec14995bcf659" }, { "column_type" : "string", "column_name" : "column_prefix7", "comment" : "d388b4d142834eaab7e55137f4b8089d" }, { "column_type" : "string", "column_name" : "column_prefix8", "comment" : "216f8d15eb044463b2e22a31f3bd40e9" }, { "column_type" : "string", "column_name" : "column_prefix9", "comment" : "7f8565e9381e4070b3faab51badfa035" } ], "location" : "obs://location/test/database/de0eef7ef86a4940a266c03bc7c5a548", "compressed" : false, "input_format" : "0a376351bf9c4966b9258301ba0473f7", "output_format" : "1297b151c9544f368f7c9a1708deb067", "number_of_buckets" : 0, "bucket_columns" : [ ], "sort_columns" : [ ], "serde_info" : { "name" : "b277e0cefeaf4f78aacffbe6bd714ca4", "serialization_library" : "8c348e0841524ce9ba0ab29cf30483cb", "parameters" : { "0804f29205a546efabd6c6934badfa81" : "4e4d5a8d807e4150af0df5cb967810dd" } }, "parameters" : { "27976ea945ed4486a938e6336e7b4923" : "679081deb759451cbc3ccacdcd4e4940", "08f5c45c202b4572b1b3c2255205a2a6" : "7cd4dab5553f4c20b3d08d2a59b8eeca" }, "skewed_info" : { "skewed_column_names" : [ ], "skewed_column_value_location_maps" : { }, "skewed_column_values" : [ ] }, "stored_as_sub_directories" : false } } ], "page_info" : { "current_count" : 1 } } ``` **状态码：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)。