DescribeWorkerDetection - AnalyticDB - Alibaba Cloud Documentation Center

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeWorkerDetection	get	DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. 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
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-beijing
StartTime	string	Yes	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.	2021-11-18T00:00Z
EndTime	string	Yes	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.	2024-04-25T02:04Z
Lang	string	No	The language. Valid values: zh (default): simplified Chinese. en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	string	The total number of entries returned.	20
RequestId	string	The request ID.	E5B37B61-E6C9-5FE0-9374-45BAA548AEF6
DBClusterId	string	The cluster ID.	am-xxxxx
DetectionItems	array<object>	The queried detection items and detection results.
BaseDetectionItem	object	The queried detection item and detection result.
Name	string	The name of the detection item.	Metric detection
Results	object	The detection result items.
SkewedTables	array<object>	The detection result items of skewed tables.
SkewedTablesList	object	The detection result items of skewed table.
SchemaName	string	The name of the database.	platfunc
TableName	string	The name of the table.	sls_log_cheat_action
DDL	string	The SQL statement that is used to create the table.	create table test(id varchar)
PartitionCount	integer	The number of partitions.	2
TotalDataSize	long	The total data size of the table. Unit: bytes.	2345
TotalRowCount	long	The number of rows in the table.	34
TotalPkSize	long	The data size of the primary key. Unit: bytes.	234
TotalRemoteDataSize	long	The size of cold data. Unit: bytes.	234
TotalLocalDataSize	string	The size of hot data. Unit: bytes.	2345
ShardSkewedRows	string	The number of skewed rows in the table.	1234
PartitionedTables	array<object>	The detection result items of improper partitioned tables.
PartitionedTablesList	object	The detection result items of the improper partitioned table.
SchemaName	string	The name of the database.	nxg
TableName	string	The name of the table.	zhw_place_order
DDL	string	The SQL statement that is used to create the table.	create table test(id varchar)
PartitionCount	string	The number of partitions.	234
PartitionIds	string	The ID of the improper partition.	[2024,2025]
TotalDataSize	long	The total data size of the table.	1234
TopAccessTables	array<object>	The detection result items of table access.
TopAccessTablesList	object	The detection result items of table access.
MetricName	string	The name of the detection metric.	Peak memory detection
SearchResults	array<object>	The detection result items of table access.
ResultList	object	The detection result items of table access.
TableName	string	The name of the table.	tiberias_2copt_origin_order_goods_info
MaxScanCost	long	The maximum amount of time for scanning. Unit: milliseconds.	345
AvgScanCost	double	The average amount of time for scanning. Unit: milliseconds.	234
MaxScanSize	long	The maximum data size for scanning. Unit: bytes.	2345
AvgScanSize	double	The average data size for scanning. Unit: bytes.	234
AccessCount	long	The number of accesses to the table.	1111
OperatorDetails	array<object>	The detection result items of abnormal operators.
BadOperatorDetails	object	The detection result items of abnormal operators.
MetricName	string	The name of the detection metric.	PeakMemory
SearchResults	array<object>	The detection result items of abnormal operators.
ResultList	object	The detection result items of the abnormal operator.
ProcessId	string	The query ID that can be used for diagnostics.	2024041909301402103302422803151411141
StageId	string	The stage ID.	Stage[2]
OperatorName	string	The name of the operator.	TableScan
PeakMemory	long	The peak memory. Unit: bytes.	23
OperatorCost	long	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.	23
InputRows	long	The number of rows input by the operator.	123
OutputRows	long	The number of rows output by the operator.	123
InputSize	long	The amount of data input by the operator. Unit: bytes.	123
OutputSize	long	The amount of data output by the operator. Unit: bytes.	123
OperatorInfo	string	The property information about the operator.	GROUP BY field: id
OperatorAgg	array<object>	The detection result items of operator metric aggregation.
BadOperatorAgg	object	The detection result items of operator metric aggregation.
MetricName	string	The detection result items of operator metric aggregation.	Peak memory
SearchResults	array<object>	The detection result items of operator metric aggregation.
ResultList	object	The detection result items of operator metric aggregation.
OperatorName	string	The name of the operator.	Aggregation
MaxValue	long	The maximum value of the operator metric.	444
TotalValue	long	The cumulative value of the operator metric.	123
AvgValue	double	The average value of the operator metric.	2234
OperatorCount	long	The number of occurrences of the operator.	1234
Message	string	The information about the detection result.	There are a total of 10 tables with an excessive number of primary keys.
Status	string	The severity level of the detection result. Valid values: NORMAL WARNING CRITICAL	WARNING

Examples

Sample success responses

JSONformat

{
  "TotalCount": 20,
  "RequestId": "E5B37B61-E6C9-5FE0-9374-45BAA548AEF6",
  "DBClusterId": "am-xxxxx",
  "DetectionItems": [
    {
      "Name": "Metric detection",
      "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": "Peak memory detection",
            "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 field: id\n"
              }
            ]
          }
        ],
        "OperatorAgg": [
          {
            "MetricName": "Peak memory",
            "SearchResults": [
              {
                "OperatorName": "Aggregation",
                "MaxValue": 444,
                "TotalValue": 123,
                "AvgValue": 2234,
                "OperatorCount": 1234
              }
            ]
          }
        ]
      },
      "Message": "There are a total of 10 tables with an excessive number of primary keys.",
      "Status": "WARNING"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The 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.