文档

DescribeTableStatistics - 查询表统计信息

更新时间:

查询目标AnalyticDB MySQL集群中的表信息统计详情。

接口说明

说明 更多关于表信息统计的详情,请参见监控信息

调试

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

授权信息

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

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

请求参数

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

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看集群 ID。
am-bp183qgrwywa6****
PageSizeinteger

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberinteger

页码,取值为大于 0 的正整数。默认值为 1

1
Orderstring

根据指定字段进行排序,格式为 JSON,是一个有序 JSON 数组,按输入数组的顺序进行复合排序,包含FieldType两个字段,例如[{ "Field":"TableName", "Type":"Asc" }]。其中:

  • Field表示需要排序的字段名,当前仅支持对TableName字段进行排序。
  • Type表示排序类型,支持如下取值(取值均不区分大小写):
    • Desc:降序。
    • Asc:升序。

支持的排序字段包括:TableName,ColdDataSize,DataSize,PrimaryKeyIndexSize,RowCount,IndexSize,SchemaName,PartitionCount

[ { "Field":"TableName", "Type":"Asc" } ]
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看地域 ID。
cn-beijing
Keywordstring

查询关键字,支持根据表名模糊搜索。

you_table_name

返回参数

名称类型描述示例值
object

信息列表。

TotalCountstring

总记录数。

1
PageSizestring

本页记录数。

30
RequestIdstring

请求 ID。

4C4433FF-5D3A-4C3E-A19C-6D93B2******
PageNumberstring

页数。

1
DBClusterIdstring

集群 ID。

am-****************
Itemsobject []

表统计信息列表。

SchemaNamestring

数据库名称。

test_schema
TableNamestring

表名称。

test_table
RowCountlong

表行数。

3
DataSizelong

表记录数据量,单位:Byte。

说明 表记录数据量,不包含普通索引、主键索引的数据。
15592
IndexSizelong

普通索引数据量,单位:Byte。

3076
PrimaryKeyIndexSizelong

主键索引数据量,单位:Byte。

16340
PartitionCountlong

分区数。

1
ColdDataSizelong

冷数据总量,单位:Byte。

说明 仅内核版本为 3.1.3.4 或以上集群才会返回该参数。
0
SpaceRatiodouble

表空间占比,单位:%。

说明 计算公式为:表空间占比 = 表总数据量 / 实例总数据量 * 100。
66.23
TotalSizelong

总数据量,单位:Byte。

说明 总数据量的计算,以下 2 个公式都成立。计算公式 1:总数据量 = 热数据量 + 冷数据量,计算公式 2:总数据量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。
1577
HotDataSizelong

热数据量,单位:Byte。

1048576
OtherSizelong

其他,单位:Byte。

1048576

示例

正常返回示例

JSON格式

{
  "TotalCount": "1",
  "PageSize": "30",
  "RequestId": "4C4433FF-5D3A-4C3E-A19C-6D93B2******",
  "PageNumber": "1",
  "DBClusterId": "am-****************",
  "Items": {
    "TableStatisticRecords": [
      {
        "SchemaName": "test_schema",
        "TableName": "test_table",
        "RowCount": 3,
        "DataSize": 15592,
        "IndexSize": 3076,
        "PrimaryKeyIndexSize": 16340,
        "PartitionCount": 1,
        "ColdDataSize": 0,
        "SpaceRatio": 66.23,
        "TotalSize": 1577,
        "HotDataSize": 1048576,
        "OtherSize": 1048576
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-14API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2024-02-20OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Keyword
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈