全部产品
Search
文档中心

云原生数据仓库AnalyticDB:DescribeTablePartitionDiagnose - 查询分区诊断信息

更新时间:Aug 30, 2024

调用DescribeTablePartitionDiagnose接口查询分区诊断信息。

调试

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

授权信息

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

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

请求参数

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

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 数仓版集群的集群 ID。
am-bpxxxxxxxx47
PageSizeinteger

每页记录数,取值:

  • 30;
  • 50;
  • 100;

默认值:30。

30
PageNumberinteger

页码,取值为:大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。

1
Orderstring

将查询结果按指定字段进行排序。格式为 JOSN 字符串,例如[{"Field":"TotalSize","Type":"Desc"}]。其中:

  • Field表示排序字段。支持如下取值:
    • SchemaName:表所属的数据库名。
    • TableName:表名。
    • TotalSize:总数据量。
    • SpaceRatio:空间占比。
  • Type表示排序方式。支持如下取值:
    • Asc:升序排序。
    • Desc: 降序排序。
说明 若不设置参数,默认按照目标表的总数据量倒序排列。
[{\"Field\":\"TotalSize\",\"Type\":\"Desc\"}]
RegionIdstring

地域 ID。

cn-hangzhou
Langstring

指定请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

参数列表。

TotalCountinteger

总记录数。

1
RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageSizeinteger

总页数。

123
PageNumberinteger

页码。

34
DBClusterIdstring

集群 ID。

rm-uf6wjk5xxxxxxxxxx
SuggestMaxRecordsPerPartitionlong

建议每个二级分区的最大行数。

640000000
SuggestMinRecordsPerPartitionlong

建议每个二级分区的最小行数。

64000000
Itemsarray<object>

表统计信息。

object

信息列表。

TableNamestring

表名。

user
PartitionDetailstring

不合理分区。

[20210110, 20210113,20210123]
SchemaNamestring

数据库名。

test_db
PartitionNumberinteger

分区个数。

34
SpaceRatiodouble

表空间占比,单位:%。

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

总数据量,单位:Byte。

42949672960
DetectionItemsarray<object>

检测项及检测结果列表。

object
Namestring

检测项名字。

表分区合理性检测
Messagestring

检测结果信息。

检测到表存在分区不合理的情况
Statusstring

检测结果状态。取值:

  • NORMAL
  • WARNING
  • CRITICAL
WARNING

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageSize": 123,
  "PageNumber": 34,
  "DBClusterId": "rm-uf6wjk5xxxxxxxxxx",
  "SuggestMaxRecordsPerPartition": 640000000,
  "SuggestMinRecordsPerPartition": 64000000,
  "Items": [
    {
      "TableName": "user",
      "PartitionDetail": "[20210110, 20210113,20210123]",
      "SchemaName": "test_db",
      "PartitionNumber": 34,
      "SpaceRatio": 66.23,
      "TotalSize": 42949672960
    }
  ],
  "DetectionItems": [
    {
      "Name": "表分区合理性检测",
      "Message": "检测到表存在分区不合理的情况",
      "Status": "WARNING"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情