Detect Storage Anomalies with DescribeWorkerDetection - AnalyticDB for MySQL - Alibaba Cloud - AnalyticDB

Queries the diagnostic results of the storage layer.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeWorkerDetection

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	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
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
StartTime	string	No	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
EndTime	string	No	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
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	string	The total number of entries returned.	144
RequestId	string	The request ID.	37A6F56E-B970-50AF-AF33-C71E57AB2C8E
DBClusterId	string	The cluster ID.	amv-xxx
DetectionItems	array<object>	The queried detection items and detection results.
	array<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.
	object	The detection result items of the skewed table.
SchemaName	string	The name of the database.	kp_ods
TableName	string	The name of the table.	train_data_test
DDL	string	The SQL statement that is used to create the table.	create table(id varchar)
PartitionCount	integer	The number of partitions.	3
TotalDataSize	integer	The total data size of the table. Unit: bytes.	2345
TotalRowCount	integer	The total number of rows in the table.	2335
TotalPkSize	integer	The data size of the primary key. Unit: bytes.	1234
TotalRemoteDataSize	integer	The size of cold data. Unit: bytes.	23456
TotalLocalDataSize	string	The size of hot data. Unit: bytes.	211
ShardSkewedRows	string	The number of skewed rows in the table.	345
PartitionedTables	array<object>	The detection result items of improper partitioned tables.
	object	The detection result items of the improper partitioned table.
SchemaName	string	The name of the database.	kp_ods
TableName	string	The name of the table.	lake_count
DDL	string	The SQL statement that is used to create the table.	create table user(id varchar)
PartitionCount	string	The number of partitions.	4
PartitionIds	string	The ID of the improper partition.	[2025,2026]
TotalDataSize	integer	1234	[2024,2025]
TopAccessTables	array<object>	The detection result items of table access.
	array<object>	The detection result items of table access.
MetricName	string	The name of the detection metric.	Table access count
SearchResults	array<object>	The detection result items of table access.
	object	The detection result items of table access.
TableName	string	The name of the table.	adb_lake_logs_pgsql
MaxScanCost	integer	The maximum amount of time for scanning. Unit: milliseconds.	2345
AvgScanCost	number	The average amount of time for scanning. Unit: milliseconds.	234
MaxScanSize	integer	The maximum data size for scanning. Unit: bytes.	234
AvgScanSize	number	The average data size for scanning. Unit: bytes.	234
AccessCount	integer	The number of accesses to the table.	345
OperatorDetails	array<object>	The detection result items of abnormal operators.
	array<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.
	object
ProcessId	string	The query ID that can be used for diagnostics.	2024072416154919216812815303453136244
StageId	string	The stage ID.	Stage[7]
OperatorName	string	The name of the operator.	TableScan
PeakMemory	integer	The peak memory. Unit: bytes.	234
OperatorCost	integer	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
InputRows	integer	The number of rows input by the operator.	235
OutputRows	integer	The number of rows output by the operator.	345
InputSize	integer	The amount of data input by the operator. Unit: bytes.	2345
OutputSize	integer	The amount of data output by the operator. Unit: bytes.	323
OperatorInfo	string	The property information about the operator.	Aggregate function:count
OperatorAgg	array<object>	The detection result items of operator metric aggregation.
	array<object>	The detection result items of operator metric aggregation.
MetricName	string	The name of the detection metric.	OperatorCost
SearchResults	array<object>	The detection result items of operator metric aggregation.
	object	The detection result items of operator metric aggregation.
OperatorName	string	The name of the operator.	StageOutput
MaxValue	integer	The maximum value of the operator metric.	3
TotalValue	integer	The cumulative value of the operator metric.	3333
AvgValue	number	The average value of the operator metric.	234
OperatorCount	integer	The number of occurrences of the operator.	345
Message	string	The information about the detection result.	Detectedmultiplemetric anomalyoperator
Status	string	The severity level of the detection result. Valid values: NORMAL WARNING CRITICAL	WARNING

Examples

Success response

JSON format

{
  "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 access count",
            "SearchResults": [
              {
                "TableName": "adb_lake_logs_pgsql",
                "MaxScanCost": 2345,
                "AvgScanCost": 234,
                "MaxScanSize": 234,
                "AvgScanSize": 234,
                "AccessCount": 345
              }
            ]
          }
        ],
        "OperatorDetails": [
          {
            "MetricName": "peakmemory",
            "SearchResults": [
              {
                "ProcessId": "2024072416154919216812815303453136244",
                "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": "Detectedmultiplemetric anomalyoperator",
      "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.