GetTableColumnStatistics - 获取数据表字段的统计信息

获取数据湖中数据表指定字段的统计信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dlf:GetTableColumnStatistics
*全部资源
*

请求语法

GET /api/metastore/catalogs/databases/tables/columnstatistics HTTP/1.1

请求参数

名称类型必填描述示例值
CatalogIdstring

数据目录 ID。

1344371
DatabaseNamestring

数据库名称。

database_test
TableNamestring

数据表名称。

test_table_20201223
ColumnNamesListString

数据表的字段列表。

返回参数

名称类型描述示例值
object

返回消息体。

Codestring

状态码。

OK
ColumnStatisticsObjListarray

字段统计信息列表。

ColumnStatisticsObj

字段统计信息。

Messagestring

返回信息。

.
RequestIdstring

请求 ID。

B7F4B621-E41E-4C84-B97F-42B5380A32BB
Successboolean

是否调用成功。

  • true:调用成功。
  • false:调用失败。
true
  • code:错误码。
  • message:错误信息。
  • requestId:标记当前请求唯一 ID。
  • Success:true/false,判定请求是否成功。如果为 true,那么 ColumnStatisticsObjList 就有值。

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "ColumnStatisticsObjList": [
    {
      "ColumnName": "col1",
      "ColumnType": "int",
      "ColumnStatisticsData": {
        "StatisticsData": "{\"numNulls\":0,\"numTrues\":1,\"numFalses\":5}",
        "StatisticsType": "BOOLEAN_STATS"
      }
    }
  ],
  "Message": ".",
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史