DescribeWorkerDetection - 存储节点检测

更新时间:
复制为 MD 格式

查询存储层诊断结果。

调试

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

授权信息

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

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

请求参数

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

数仓版集群 ID。

说明 您可以调用 DescribeDBClusters 接口查询集群 ID。
am-xxxxx
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息,包括地域 ID。
cn-hangzhou
StartTimestring

查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

说明 仅支持查看最近 15 天内的数据。
2011-06-01T16:00Z
EndTimestring

查询结束时间,需要大于查询开始时间,格式:yyyy-MM-ddTHH:mmZ。

2024-04-25T02:04Z
Langstring

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

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object
TotalCountstring

总记录数。

144
RequestIdstring

请求 ID。

37A6F56E-B970-50AF-AF33-C71E57AB2C8E
DBClusterIdstring

集群 ID。

amv-xxx
DetectionItemsarray<object>

检测项及检测结果列表。

BaseDetectionItemobject

检测项。

Namestring

检测项名字。

指标检测
Resultsobject

检测结果。

SkewedTablesarray<object>

表倾斜检测结果列表。

SkewedTablesListobject

检测结果。

SchemaNamestring

数据库名。

kp_ods
TableNamestring

表名称。

train_data_test
DDLstring

建表语句。

create table(id varchar)
PartitionCountinteger

分区数。

3
TotalDataSizelong

表总数据量,单位 Byte。

2345
TotalRowCountlong

表总行数。

2335
TotalPkSizelong

主键数据量,单位 Byte。

1234
TotalRemoteDataSizelong

总的冷数据量,单位 Byte。

23456
TotalLocalDataSizestring

本地数据量,单位 Byte。

211
ShardSkewedRowsstring

表倾斜行数。

345
PartitionedTablesarray<object>

分区表不合理检测结果集合。

PartitionedTablesListobject

分区表不合理检测结果。

SchemaNamestring

数据库名。

kp_ods
TableNamestring

表名称。

lake_count
DDLstring

建表语句。

create table user(id varchar)
PartitionCountstring

分区数。

4
PartitionIdsstring

不合理分区 ID。

[2025,2026]
TotalDataSizelong

1234

[2024,2025]
TopAccessTablesarray<object>

表访问检测结果结合。

TopAccessTablesListobject

表访问检测结果。

MetricNamestring

检测指标名。

表访问次数
SearchResultsarray<object>

检测结果结合。

ResultListobject

检测结果。

TableNamestring

表名。

adb_lake_logs_pgsql
MaxScanCostlong

最大扫描耗时,单位 ms。

2345
AvgScanCostdouble

平均扫描耗时,单位 ms。

234
MaxScanSizelong

最大扫描数据量,单位 Byte。

234
AvgScanSizedouble

平均扫描量,单位:Byte。

234
AccessCountlong

表被访问的次数。

345
OperatorDetailsarray<object>

异常算子详情列表。

BadOperatorDetailsobject

异常算子详情。

MetricNamestring

检测指标名。

峰值内存
SearchResultsarray<object>

检测结果集合。

ResultListobject
ProcessIdstring

返回 SQL 查询 ID,便于用户诊断。

2024072416154919216812815303453136244
StageIdstring

StageID。

Stage[7]
OperatorNamestring

算子名。

TableScan
PeakMemorylong

峰值内存,单位 Byte。

234
OperatorCostlong

算在 CPU Cost,单位 ms。

235
InputRowslong

算子输入行数。

235
OutputRowslong

算子输出行数。

345
InputSizelong

算子输入数据量,单位 Byte。

2345
OutputSizelong

算子输出数据量,单位 Byte。

323
OperatorInfostring

算子属性信息。

聚合函数:count
OperatorAggarray<object>

算子聚合结果检测结果结合。

BadOperatorAggobject

算子聚合结果检测结果。

MetricNamestring

检测指标名。

OperatorCost
SearchResultsarray<object>

检测结果集合。

ResultListobject

检测结果。

OperatorNamestring

算子名。

StageOutput
MaxValuelong

检测指标最大值。

3
TotalValuelong

指标累加值。

3333
AvgValuedouble

指标平均值。

234
OperatorCountlong

算子出现次数。

345
Messagestring

检测结果信息。

检测到存在多个指标异常算子
Statusstring

检测结果状态。取值:

  • NORMAL
  • WARNING
  • CRITICAL
WARNING

示例

正常返回示例

JSON格式

{
  "TotalCount": 144,
  "RequestId": "37A6F56E-B970-50AF-AF33-C71E57AB2C8E",
  "DBClusterId": "amv-xxx",
  "DetectionItems": [
    {
      "Name": "指标检测",
      "Results": {
        "SkewedTables": [
          {
            "SchemaName": "kp_ods",
            "TableName": "train_data_test",
            "DDL": "create table(id varchar)",
            "PartitionCount": 3,
            "TotalDataSize": 2345,
            "TotalRowCount": 2335,
            "TotalPkSize": 1234,
            "TotalRemoteDataSize": 23456,
            "TotalLocalDataSize": 211,
            "ShardSkewedRows": 345
          }
        ],
        "PartitionedTables": [
          {
            "SchemaName": "kp_ods",
            "TableName": "lake_count",
            "DDL": "create table user(id varchar)",
            "PartitionCount": 4,
            "PartitionIds": [
              2025,
              2026
            ],
            "TotalDataSize": 0
          }
        ],
        "TopAccessTables": [
          {
            "MetricName": "表访问次数",
            "SearchResults": [
              {
                "TableName": "adb_lake_logs_pgsql",
                "MaxScanCost": 2345,
                "AvgScanCost": 234,
                "MaxScanSize": 234,
                "AvgScanSize": 234,
                "AccessCount": 345
              }
            ]
          }
        ],
        "OperatorDetails": [
          {
            "MetricName": "峰值内存",
            "SearchResults": [
              {
                "ProcessId": 2.0240724161549193e+36,
                "StageId": "Stage[7]",
                "OperatorName": "TableScan",
                "PeakMemory": 234,
                "OperatorCost": 235,
                "InputRows": 235,
                "OutputRows": 345,
                "InputSize": 2345,
                "OutputSize": 323,
                "OperatorInfo": "聚合函数:count"
              }
            ]
          }
        ],
        "OperatorAgg": [
          {
            "MetricName": "OperatorCost",
            "SearchResults": [
              {
                "OperatorName": "StageOutput",
                "MaxValue": 3,
                "TotalValue": 3333,
                "AvgValue": 234,
                "OperatorCount": 345
              }
            ]
          }
        ]
      },
      "Message": "检测到存在多个指标异常算子",
      "Status": "WARNING"
    }
  ]
}

错误码

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

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