文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ LakeCat/ 分区统计信息/ 批量获取分区的列统计信息

更新时间：2024-02-21 GMT+08:00

批量获取分区的列统计信息

功能介绍

批量获取分区的列统计信息。

调试

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

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。
instance_id	是	String	LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。
catalog_name	是	String	catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。
database_name	是	String	数据库名称。只能包含中文、字母、数字、下划线、中划线，且长度为1~128个字符。
table_name	是	String	表名称。只能包含中文、字母、数字、下划线、中划线，且长度为1~256个字符。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	Array of strings	租户token。

表3 请求Body参数
参数	是否必选	参数类型	描述
aggregate_statics	是	Boolean	是否聚合返回统计信息。
column_names	是	Array of strings	统计信息的列名。
partition_values_list	是	Array<Array<String>>	需要统计的分区值列表。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
found_partition_number	Integer	分区统计信息的数量。
column_statistics	Map<String,Array<ColumnStatisticsObj>>	分区统计信息的列表。

表5 ColumnStatisticsObj
参数	参数类型	描述
column_name	String	列名称。只能包含中文、字母、数字和_-+*(), 特殊字符，且长度为1~767个字符。
column_type	String	数据类型，字段类型包括array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar
data_type	String	统计信息类型：binaryStats、booleanStats、dateStats、decimalStats、doubleStats、longStats、stringStats。枚举值： 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	布尔类型统计信息。

表6 BinaryColumnStatisticsData
参数	参数类型	描述
maximum_length	Long	列中字节数组的最大值。
average_length	Double	列中字节数组的平均长度。
number_of_null	Long	列中空值个数。

表7 LongColumnStatisticsData
参数	参数类型	描述
minimum_value	Long	列中长整数最小值。
maximum_value	Long	列中长整数最大值。
number_of_null	Long	列中空值个数。
number_of_distinct_value	Long	列中去重后的长整数个数。
bit_vector	String	估算唯一值使用的位图。

表8 DecimalColumnStatisticsData
参数	参数类型	描述
minimum_value	Decimal object	列中小数最小值。
maximum_value	Decimal object	列中小数最大值。
number_of_null	Long	列中空值个数。
number_of_distinct_value	Long	列中去重后的小数个数。
bit_vector	String	估算唯一值使用的位图。

表9 Decimal
参数	参数类型	描述
scale	Integer	整数部分。
unscaled	String	小数部分。

**表10** StringColumnStatisticsData
参数	参数类型	描述
average_length	Double	列中字符串平均长度。
maximum_length	Long	列中字符串最长长度。
number_of_null	Long	列中空值个数。
number_of_distinct_value	Long	列中去重后字符串个数。
bit_vector	String	估算唯一值使用的位图。

**表11** DoubleColumnStatisticsData
参数	参数类型	描述
minimum_value	Double	列中浮点数最小值。
maximum_value	Double	列中浮点数最大值。
number_of_null	Long	列中空值个数。
number_of_distinct_value	Long	列中去重后浮点数个数。
bit_vector	String	估算唯一值使用的位图。

**表12** DateColumnStatisticsData
参数	参数类型	描述
minimum_value	String	列中的最小时间戳。
maximum_value	String	列中的最大时间戳。
number_of_null	Long	列中空值个数。
number_of_distinct_value	Long	列中去重后的时间戳个数。
bit_vector	String	估算唯一值使用的位图。

**表13** BooleanColumnStatisticsData
参数	参数类型	描述
number_of_true	Long	列中为真的数量。
number_of_false	Long	列中为假的数量。
number_of_null	Long	列中为空的数量。

状态码： 400

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
solution_msg	String	解决方案描述。

状态码： 404

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
solution_msg	String	解决方案描述。

状态码： 500

**表16** 响应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

{
  "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

错误码

请参见错误码。

父主题： 分区统计信息

上一篇：分区统计信息

下一篇：批量设置分区的统计信息

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消