DescribeWorkerDetection - 预留节点检测_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

查询存储层诊断结果。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeWorkerDetection	get	DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 集群的详情，包括集群 ID。	am-xxxxx
RegionId	string	是	地域 ID。说明您可以调用 DescribeRegions 接口查看地域 ID。	cn-beijing
StartTime	string	是	查询开始时间。格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2021-11-18T00:00Z
EndTime	string	是	查询结束时间。格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2024-04-25T02:04Z
Lang	string	否	设置建议的显示语言，取值说明： zh：简体中文（默认语言）。 en：英文。	zh

返回参数

名称	类型	描述	示例值
	object
TotalCount	string	总记录数。	20
RequestId	string	请求 ID。	E5B37B61-E6C9-5FE0-9374-45BAA548AEF6
DBClusterId	string	集群 ID。	am-xxxxx
DetectionItems	array<object>	检测项及检测结果列表。
BaseDetectionItem	object	检测结果。
Name	string	检测项名字。	指标检测
Results	object	检测结果。
SkewedTables	array<object>	表倾斜检测。
SkewedTablesList	object
SchemaName	string	数据库名。	platfunc
TableName	string	表名。	sls_log_cheat_action
DDL	string	建表语句。	create table test(id varchar)
PartitionCount	integer	分区数。	2
TotalDataSize	long	表数据量，单位 Byte。	2345
TotalRowCount	long	表行数。	34
TotalPkSize	long	表主键数据量，单位 Byte。	234
TotalRemoteDataSize	long	冷数据量，单位 Byte。	234
TotalLocalDataSize	string	本地数据量，单位 Byte。	2345
ShardSkewedRows	string	表倾斜行数。	1234
PartitionedTables	array<object>	分区不合理表集合。
PartitionedTablesList	object	不合理分区表。
SchemaName	string	数据库名称。	nxg
TableName	string	表名。	zhw_place_order
DDL	string	建表语句。	create table test(id varchar)
PartitionCount	string	分区数。	234
PartitionIds	string	不合理分区 ID。	[2024,2025]
TotalDataSize	long	表总的数据量。	1234
TopAccessTables	array<object>	表访问检测结果集合。
TopAccessTablesList	object	表访问检测结果。
MetricName	string	检测指标名。	峰值内存检测
SearchResults	array<object>	表访问检索结果集合。
ResultList	object	表访问检索结果。
TableName	string	表名。	tiberias_2copt_origin_order_goods_info
MaxScanCost	long	最大扫描耗时，单位 ms。	345
AvgScanCost	double	平均扫描耗时，单位 ms。	234
MaxScanSize	long	最大数据读取量，单位 Byte。	2345
AvgScanSize	double	平均表读取量，单位 Byte。	234
AccessCount	long	表被访问的次数。	1111
OperatorDetails	array<object>	算子检测结果集合。
BadOperatorDetails	object	算子检测结果。
MetricName	string	指标名。	PeakMemory
SearchResults	array<object>	检索结果集合。
ResultList	object	算子检测结果。
ProcessId	string	返回 SQL 查询 ID，便于用户诊断。	2024041909301402103302422803151411141
StageId	string	阶段 ID。	Stage[2]
OperatorName	string	算子名。	TableScan
PeakMemory	long	算子消耗的峰值内存，单位 Byte。	23
OperatorCost	long	该阶段内部总的算子耗时，等同于该阶段的 CPU Time，可用于判断查询哪些部分消耗了较多的计算资源。单位为毫秒（ms）。	23
InputRows	long	算子的输入行数。	123
OutputRows	long	算子的输出行数。	123
InputSize	long	算子的输入数据量，单位 Byte。	123
OutputSize	long	算子的输出数据量，单位 Byte。	123
OperatorInfo	string	算子属性信息。	Group By字段：id
OperatorAgg	array<object>	算子指标聚合检测结果。
BadOperatorAgg	object
MetricName	string	算子指标聚合检测项名。	峰值内存
SearchResults	array<object>	算子聚合指标检索结果集合。
ResultList	object
OperatorName	string	算子名。	Aggregation
MaxValue	long	算子指标最大值。	444
TotalValue	long	算子指标累加值。	123
AvgValue	double	算子指标平均值。	2234
OperatorCount	long	算子出现次数。	1234
Message	string	检测结果信息。	检测到多个表存在主键过多的问题
Status	string	检测结果状态。取值： NORMAL WARNING CRITICAL	WARNING

示例

正常返回示例

JSON格式

{
  "TotalCount": 20,
  "RequestId": "E5B37B61-E6C9-5FE0-9374-45BAA548AEF6",
  "DBClusterId": "am-xxxxx",
  "DetectionItems": [
    {
      "Name": "指标检测",
      "Results": {
        "SkewedTables": [
          {
            "SchemaName": "platfunc",
            "TableName": "sls_log_cheat_action",
            "DDL": "create table test(id varchar)",
            "PartitionCount": 2,
            "TotalDataSize": 2345,
            "TotalRowCount": 34,
            "TotalPkSize": 234,
            "TotalRemoteDataSize": 234,
            "TotalLocalDataSize": 2345,
            "ShardSkewedRows": 1234
          }
        ],
        "PartitionedTables": [
          {
            "SchemaName": "nxg",
            "TableName": "zhw_place_order",
            "DDL": "create table test(id varchar)",
            "PartitionCount": 234,
            "PartitionIds": [
              2024,
              2025
            ],
            "TotalDataSize": 1234
          }
        ],
        "TopAccessTables": [
          {
            "MetricName": "峰值内存检测",
            "SearchResults": [
              {
                "TableName": "tiberias_2copt_origin_order_goods_info",
                "MaxScanCost": 345,
                "AvgScanCost": 234,
                "MaxScanSize": 2345,
                "AvgScanSize": 234,
                "AccessCount": 1111
              }
            ]
          }
        ],
        "OperatorDetails": [
          {
            "MetricName": "PeakMemory",
            "SearchResults": [
              {
                "ProcessId": 2.0240419093014022e+36,
                "StageId": "Stage[2]",
                "OperatorName": "TableScan",
                "PeakMemory": 23,
                "OperatorCost": 23,
                "InputRows": 123,
                "OutputRows": 123,
                "InputSize": 123,
                "OutputSize": 123,
                "OperatorInfo": "Group By字段：id"
              }
            ]
          }
        ],
        "OperatorAgg": [
          {
            "MetricName": "峰值内存",
            "SearchResults": [
              {
                "OperatorName": "Aggregation",
                "MaxValue": 444,
                "TotalValue": 123,
                "AvgValue": 2234,
                "OperatorCount": 1234
              }
            ]
          }
        ]
      },
      "Message": "检测到多个表存在主键过多的问题",
      "Status": "WARNING"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

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