# 批量获取分区的列统计信息 - BatchShowPartitionColumnStatistics #### 功能介绍 批量获取分区的列统计信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/LakeFormation/doc?api=BatchShowPartitionColumnStatistics)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lakeformation/abcd.html)。 #### URI POST /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/tables/{table_name}/partitions/column-statistics/batch-get 表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个字符 **默认取值:** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | Array of strings | **参数解释:** 租户token。 **约束限制:** 数组元素个数为1\~100 **取值范围:** 数组元素个数为1\~100 **默认取值:** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | aggregate_statics | 是 | Boolean | **参数解释:** 是否聚合返回统计信息 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | | column_names | 是 | Array of strings | **参数解释:** 统计信息的列名 **约束限制:** 数组元素个数为0\~2000 **取值范围:** 长度为1\~767个字符，数组元素个数为0\~2000 **默认取值:** 不涉及 | | partition_values_list | 是 | Array\\> | **参数解释:** 需要统计的分区值列表 **约束限制:** 数组元素个数为0\~1000 **取值范围:** 长度为1\~256个字符，数组元素个数为0\~1000 **默认取值:** 不涉及 | | spec_id | 否 | String | **参数解释:** iceberg分区规范id **约束限制:** 长度为0\~64个字符 **取值范围:** 长度为0\~64个字符 **默认取值:** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | found_partition_number | Integer | **参数解释:** 分区统计信息的数量 | | column_statistics | Map\\> | **参数解释:** 分区统计信息的列表 | 表5ColumnStatisticsObj | 参数 | 参数类型 | 描述 | |:---|:---|:---| | column_name | String | **参数解释:** 列名称。只能包含中文、字母、数字和_-+\*(), 特殊字符，且长度为1\~767个字符 **取值范围:** 长度为1\~767个字符 | | column_type | String | **参数解释:** 列类型。 **取值范围:** 长度为1\~50个字符 | | data_type | String | **参数解释:** 统计信息类型：binaryStats、booleanStats、dateStats、decimalStats、doubleStats、longStats、stringStats **取值范围:** 不涉及 | | binary_statistics_data | [BinaryColumnStatisticsData] object | **参数解释:** 字节数组类型统计信息 **取值范围:** 不涉及 | | long_statistics_data | [LongColumnStatisticsData] object | **参数解释:** 长整数类型统计信息 **取值范围:** 不涉及 | | decimal_statistics_data | [DecimalColumnStatisticsData] object | **参数解释:** 小数类型统计信息 **取值范围:** 不涉及 | | string_statistics_data | [StringColumnStatisticsData] object | **参数解释:** 字符串类型统计信息 **取值范围:** 不涉及 | | double_statistics_data | [DoubleColumnStatisticsData] object | **参数解释:** 浮点数类型统计信息 **取值范围:** 不涉及 | | date_statistics_data | [DateColumnStatisticsData] object | **参数解释:** 日期类型统计信息 **取值范围:** 不涉及 | | boolean_statistics_data | [BooleanColumnStatisticsData] object | **参数解释:** 布尔类型统计信息 **取值范围:** 不涉及 | 表6BinaryColumnStatisticsData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | maximum_length | Long | **参数解释:** 列中字节数组的最大值 **取值范围:** 不涉及 | | average_length | Double | **参数解释:** 列中字节数组的平均长度 **取值范围:** 不涉及 | | number_of_null | Long | **参数解释:** 列中空值个数 **取值范围:** 不涉及 | | mcv | String | **参数解释:** mcv值 **取值范围:** 最小长度为0 | | mcv_frequency | String | **参数解释:** mcv值对应的频率 **取值范围:** 最小长度为0 | | histogram | String | **参数解释:** 直方图 **取值范围:** 最小长度为0 | 表7LongColumnStatisticsData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | minimum_value | Long | **参数解释:** 列中长整数最小值 **取值范围:** 不涉及 | | maximum_value | Long | **参数解释:** 列中长整数最大值 **取值范围:** 不涉及 | | number_of_null | Long | **参数解释:** 列中空值个数 **取值范围:** 不涉及 | | number_of_distinct_value | Long | **参数解释:** 列中去重后的长整数个数 **取值范围:** 不涉及 | | bit_vector | String | **参数解释:** 估算唯一值使用的位图 **取值范围:** 最大长度为66560 | | mcv | String | **参数解释:** mcv值 **取值范围:** 最小长度为0 | | mcv_frequency | String | **参数解释:** mcv值对应的频率 **取值范围:** 最小长度为0 | | histogram | String | **参数解释:** 直方图 **取值范围:** 最小长度为0 | 表8DecimalColumnStatisticsData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | minimum_value | [Decimal] object | **参数解释:** 列中小数最小值 **取值范围:** 不涉及 | | maximum_value | [Decimal] object | **参数解释:** 列中小数最大值 **取值范围:** 不涉及 | | number_of_null | Long | **参数解释:** 列中空值个数 **取值范围:** 不涉及 | | number_of_distinct_value | Long | **参数解释:** 列中去重后的小数个数 **取值范围:** 不涉及 | | bit_vector | String | **参数解释:** 估算唯一值使用的位图 **取值范围:** 最大长度为66560 | | mcv | String | **参数解释:** mcv值 **取值范围:** 最小长度为0 | | mcv_frequency | String | **参数解释:** mcv值对应的频率 **取值范围:** 最小长度为0 | | histogram | String | **参数解释:** 直方图 **取值范围:** 最小长度为0 | 表9Decimal | 参数 | 参数类型 | 描述 | |:---|:---|:---| | scale | Integer | **参数解释:** 整数部分 **取值范围:** 取值为-2147483646\~2147483647 | | unscaled | String | **参数解释:** 小数部分 **取值范围:** 最大长度为125 | 表10StringColumnStatisticsData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | average_length | Double | **参数解释:** 列中字符串平均长度 **取值范围:** 不涉及 | | maximum_length | Long | **参数解释:** 列中字符串最长长度 **取值范围:** 不涉及 | | number_of_null | Long | **参数解释:** 列中空值个数 **取值范围:** 不涉及 | | number_of_distinct_value | Long | **参数解释:** 列中去重后字符串个数 **取值范围:** 不涉及 | | bit_vector | String | **参数解释:** 估算唯一值使用的位图 **取值范围:** 最大长度为66560 | | mcv | String | **参数解释:** mcv值 **取值范围:** 不涉及 | | mcv_frequency | String | **参数解释:** mcv值对应的频率 **取值范围:** 不涉及 | | histogram | String | **参数解释:** 直方图 **取值范围:** 不涉及 | 表11DoubleColumnStatisticsData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | minimum_value | Double | **参数解释:** 列中浮点数最小值 **取值范围:** 不涉及 | | maximum_value | Double | **参数解释:** 列中浮点数最大值 **取值范围:** 不涉及 | | number_of_null | Long | **参数解释:** 列中空值个数 **取值范围:** 不涉及 | | number_of_distinct_value | Long | **参数解释:** 列中去重后浮点数个数 **取值范围:** 不涉及 | | bit_vector | String | **参数解释:** 估算唯一值使用的位图 **取值范围:** 最大长度为66560 | | mcv | String | **参数解释:** mcv值 **取值范围:** 最小长度为0 | | mcv_frequency | String | **参数解释:** mcv值对应的频率 **取值范围:** 最小长度为0 | | histogram | String | **参数解释:** 直方图 **取值范围:** 最小长度为0 | 表12DateColumnStatisticsData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | minimum_value | String | **参数解释:** 列中的最小时间戳 **取值范围:** 不涉及 | | maximum_value | String | **参数解释:** 列中的最大时间戳 **取值范围:** 不涉及 | | number_of_null | Long | **参数解释:** 列中空值个数 **取值范围:** 不涉及 | | number_of_distinct_value | Long | **参数解释:** 列中去重后的时间戳个数 **取值范围:** 不涉及 | | bit_vector | String | **参数解释:** 估算唯一值使用的位图 **取值范围:** 最大长度为66560 | | mcv | String | **参数解释:** mcv值 **取值范围:** 最小长度为0 | | mcv_frequency | String | **参数解释:** mcv值对应的频率 **取值范围:** 最小长度为0 | | histogram | String | **参数解释:** 直方图 **取值范围:** 最小长度为0 | 表13BooleanColumnStatisticsData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | number_of_true | Long | **参数解释:** 列中为真的数量 **取值范围:** 不涉及 | | number_of_false | Long | **参数解释:** 列中为假的数量 **取值范围:** 不涉及 | | number_of_null | Long | **参数解释:** 列中为空的数量 **取值范围:** 不涉及 | | mcv | String | **参数解释:** mcv值 **取值范围:** 最小长度为0 | | mcv_frequency | String | **参数解释:** mcv值对应的频率 **取值范围:** 最小长度为0 | | histogram | String | **参数解释:** 直方图 **取值范围:** 最小长度为0 | **状态码：201** Created **状态码：400** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：401** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：403** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释:** 错误信息 | | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | title | String | **参数解释:** 标题 | 表17Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | title | String | **参数解释:** 标题 | | message | String | **参数解释:** 错误信息 | | code | String | **参数解释:** 状态码 | **状态码：404** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：408** 表19响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：500** 表20响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | solution_msg | String | **参数解释:** 解决方案描述 | #### 请求示例 ``` POST https://{endpoint} /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/tables/{table_name}/partitions/column-statistics/batch-get { "aggregate_statics" : false, "column_names" : [ "column1", "column2" ], "partition_values_list" : [ [ "value1", "value2" ] ] } ``` #### 响应示例 **状态码：200** OK ``` { "found_partition_number" : 1, "column_statistics" : { "part1=value1/part2=value2" : [ { "column_name" : "columnName", "column_type" : "bigint", "data_type" : "longStats", "long_statistics_data" : { "minimum_value" : 10, "maximum_value" : 1000, "number_of_null" : 30, "number_of_distinct_value" : 20 } } ] } } ``` **状态码：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 | | 201 | Created | | 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)。