Call DescribeExecutorDetection to Retrieve Executor Diagnostics - AnalyticDB for MySQL - Alibaba Cloud - AnalyticDB

Queries the diagnostic results of the compute 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:DescribeExecutorDetection

get

DBCluster

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

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-xxxx
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.	2024-10-31T02:06Z
EndTime	string	No	The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Note The end time must be later than the start time. The maximum time range that can be specified is 24 hours.	2021-05-27T16:00Z
Lang	string	No	The language. Valid values: zh: simplified Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	string	The total number of entries returned.	20
RequestId	string	The request ID.	B20BA053-27A1-5FDF-B063-6D6146720DF6
DBClusterId	string	The cluster ID.	am-xxxx
DetectionItems	array<object>	The detection items and results.
	array<object>	The detection item and result.
Name	string	The name of the detection item.	CPUincrease detection
Results	object	The detection result items.
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	The detection result items of the abnormal operator.
ProcessId	string	The query ID that can be used for diagnostics.	202405061006230110150170540315119xxxx
StageId	string	The stage ID.	Stage[7]
OperatorName	string	The name of the operator.	TableScan
PeakMemory	integer	The peak memory of the operator.	2334
OperatorCost	number	The total CPU time consumed by all operators in the stage, which is equivalent to the total CPU time of the stage. Use this value to identify which parts of the stage consume a large amount of computing resources. Unit: milliseconds.	2354
InputRows	integer	The number of rows input by the operator.	123
OutputRows	integer	The number of rows output by the operator.	2354
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.	2345
OperatorInfo	string	The properties of the operator.	Group Byfield:uid
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.	PeakMemory
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.	Aggregation
MaxValue	integer	The maximum value of the operator metric.	2335
TotalValue	integer	The cumulative value of the operator metric.	234
AvgValue	number	The average value of the operator metric.	235.5
OperatorCount	integer	The number of occurrences of the operator.	5
Message	string	The detection result details.	Detected Aggregation operator consuming high memory resources
Status	string	The severity level of the detection result. Valid values: NORMAL WARNING CRITICAL	WARNING

Examples

Success response

JSON format

{
  "TotalCount": "20",
  "RequestId": "B20BA053-27A1-5FDF-B063-6D6146720DF6",
  "DBClusterId": "am-xxxx",
  "DetectionItems": [
    {
      "Name": "CPUincrease detection",
      "Results": {
        "OperatorDetails": [
          {
            "MetricName": "PeakMemory",
            "SearchResults": [
              {
                "ProcessId": "202405061006230110150170540315119xxxx",
                "StageId": "Stage[7]",
                "OperatorName": "TableScan",
                "PeakMemory": 2334,
                "OperatorCost": 2354,
                "InputRows": 123,
                "OutputRows": 2354,
                "InputSize": 2345,
                "OutputSize": 2345,
                "OperatorInfo": "Group Byfield:uid"
              }
            ]
          }
        ],
        "OperatorAgg": [
          {
            "MetricName": "PeakMemory",
            "SearchResults": [
              {
                "OperatorName": "Aggregation",
                "MaxValue": 2335,
                "TotalValue": 234,
                "AvgValue": 235.5,
                "OperatorCount": 5
              }
            ]
          }
        ]
      },
      "Message": "Detected Aggregation operator consuming high memory resources",
      "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.