All Products
Search
Document Center

AnalyticDB:DescribeWorkerDetection

Last Updated:Jan 08, 2026

Queries the diagnostic results of the storage layer.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeWorkerDetectionget
DBCluster
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.

Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.
am-xxxxx
RegionIdstringYes

The region ID.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
StartTimestringYes

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Note You can query data only within the last 15 days.
2011-06-01T16:00Z
EndTimestringYes

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later than the start time.

2024-04-25T02:04Z
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese.
  • en: English.
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountstring

The total number of entries returned.

144
RequestIdstring

The request ID.

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

The cluster ID.

amv-xxx
DetectionItemsarray<object>

The queried detection items and detection results.

BaseDetectionItemobject

The queried detection item and detection result.

Namestring

The name of the detection item.

Metric detection
Resultsobject

The detection result items.

SkewedTablesarray<object>

The detection result items of skewed tables.

SkewedTablesListobject

The detection result items of the skewed table.

SchemaNamestring

The name of the database.

kp_ods
TableNamestring

The name of the table.

train_data_test
DDLstring

The SQL statement that is used to create the table.

create table(id varchar)
PartitionCountinteger

The number of partitions.

3
TotalDataSizelong

The total data size of the table. Unit: bytes.

2345
TotalRowCountlong

The total number of rows in the table.

2335
TotalPkSizelong

The data size of the primary key. Unit: bytes.

1234
TotalRemoteDataSizelong

The size of cold data. Unit: bytes.

23456
TotalLocalDataSizestring

The size of hot data. Unit: bytes.

211
ShardSkewedRowsstring

The number of skewed rows in the table.

345
PartitionedTablesarray<object>

The detection result items of improper partitioned tables.

PartitionedTablesListobject

The detection result items of the improper partitioned table.

SchemaNamestring

The name of the database.

kp_ods
TableNamestring

The name of the table.

lake_count
DDLstring

The SQL statement that is used to create the table.

create table user(id varchar)
PartitionCountstring

The number of partitions.

4
PartitionIdsstring

The ID of the improper partition.

[2025,2026]
TotalDataSizelong

1234

[2024,2025]
TopAccessTablesarray<object>

The detection result items of table access.

TopAccessTablesListobject

The detection result items of table access.

MetricNamestring

The name of the detection metric.

Table accesses
SearchResultsarray<object>

The detection result items of table access.

ResultListobject

The detection result items of table access.

TableNamestring

The name of the table.

adb_lake_logs_pgsql
MaxScanCostlong

The maximum amount of time for scanning. Unit: milliseconds.

2345
AvgScanCostdouble

The average amount of time for scanning. Unit: milliseconds.

234
MaxScanSizelong

The maximum data size for scanning. Unit: bytes.

234
AvgScanSizedouble

The average data size for scanning. Unit: bytes.

234
AccessCountlong

The number of accesses to the table.

345
OperatorDetailsarray<object>

The detection result items of abnormal operators.

BadOperatorDetailsobject

The detection result items of abnormal operators.

MetricNamestring

The name of the detection metric.

Peak memory
SearchResultsarray<object>

The detection result items of abnormal operators.

ResultListobject
ProcessIdstring

The query ID that can be used for diagnostics.

2024072416154919216812815303453136244
StageIdstring

The stage ID.

Stage[7]
OperatorNamestring

The name of the operator.

TableScan
PeakMemorylong

The peak memory. Unit: bytes.

234
OperatorCostlong

The total CPU time consumed by all operators in the stage, which is equivalent to the total CPU time of the stage. You can use this parameter to determine which parts of the stage consume a large amount of computing resources. Unit: milliseconds.

235
InputRowslong

The number of rows input by the operator.

235
OutputRowslong

The number of rows output by the operator.

345
InputSizelong

The amount of data input by the operator. Unit: bytes.

2345
OutputSizelong

The amount of data output by the operator. Unit: bytes.

323
OperatorInfostring

The property information about the operator.

Aggregate function: count
OperatorAggarray<object>

The detection result items of operator metric aggregation.

BadOperatorAggobject

The detection result items of operator metric aggregation.

MetricNamestring

The name of the detection metric.

OperatorCost
SearchResultsarray<object>

The detection result items of operator metric aggregation.

ResultListobject

The detection result items of operator metric aggregation.

OperatorNamestring

The name of the operator.

StageOutput
MaxValuelong

The maximum value of the operator metric.

3
TotalValuelong

The cumulative value of the operator metric.

3333
AvgValuedouble

The average value of the operator metric.

234
OperatorCountlong

The number of occurrences of the operator.

345
Messagestring

The information about the detection result.

Multiple abnormal operators are detected.
Statusstring

The severity level of the detection result. Valid values:

  • NORMAL
  • WARNING
  • CRITICAL
WARNING

Examples

Sample success responses

JSONformat

{
  "TotalCount": 144,
  "RequestId": "37A6F56E-B970-50AF-AF33-C71E57AB2C8E",
  "DBClusterId": "amv-xxx",
  "DetectionItems": [
    {
      "Name": "Metric detection",
      "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": "Table accesses",
            "SearchResults": [
              {
                "TableName": "adb_lake_logs_pgsql",
                "MaxScanCost": 2345,
                "AvgScanCost": 234,
                "MaxScanSize": 234,
                "AvgScanSize": 234,
                "AccessCount": 345
              }
            ]
          }
        ],
        "OperatorDetails": [
          {
            "MetricName": "Peak memory",
            "SearchResults": [
              {
                "ProcessId": 2.0240724161549193e+36,
                "StageId": "Stage[7]",
                "OperatorName": "TableScan",
                "PeakMemory": 234,
                "OperatorCost": 235,
                "InputRows": 235,
                "OutputRows": 345,
                "InputSize": 2345,
                "OutputSize": 323,
                "OperatorInfo": "Aggregate function: count"
              }
            ]
          }
        ],
        "OperatorAgg": [
          {
            "MetricName": "OperatorCost",
            "SearchResults": [
              {
                "OperatorName": "StageOutput",
                "MaxValue": 3,
                "TotalValue": 3333,
                "AvgValue": 234,
                "OperatorCount": 345
              }
            ]
          }
        ]
      },
      "Message": "Multiple abnormal operators are detected.",
      "Status": "WARNING"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

For a list of error codes, visit the Service error codes.