DescribeExecutorDetection - AnalyticDB - Alibaba Cloud Documentation Center

Queries the diagnostic results of the compute 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:DescribeExecutorDetection	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-xxx
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-shenzhen
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.	2024-10-31T02:06Z
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.	2021-05-27T16:00Z
Lang	string	No	The language. Valid values: zh: simplified Chinese. en: English.	zh

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	string	The total number of entries returned.	566
RequestId	string	The request ID.	9DFF5F54-162B-5860-80A5-411FF550B347
DBClusterId	string	The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.	am-xxx
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.
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 abnormal operators.
ProcessId	string	The query ID.	2024080110010002102500023803151627972
StageId	string	The stage ID.	Stage[3]
OperatorName	string	The name of the operator.	Join
PeakMemory	long	The peak memory. Unit: bytes.	234
OperatorCost	double	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.	123
InputRows	long	The number of rows input by the operator.	123
OutputRows	long	The number of rows output by the operator.	2345
InputSize	long	The amount of data input by the operator. Unit: bytes.	345
OutputSize	long	The amount of data output by the operator. Unit: bytes.	234
OperatorInfo	string	The property information about the operator.	GROUP BY field: uid
OperatorAgg	array<object>	The detection result items of operator metric aggregation.
BadOperatorAgg	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.
resultList	object	The detection result items of operator metric aggregation.
OperatorName	string	The name of the operator.	Window
MaxValue	long	The maximum value of the operator metric.	2345
TotalValue	long	The cumulative value of the operator metric.	345
AvgValue	double	The average value of the operator metric.	234
OperatorCount	long	The number of occurrences of the operator.	3
Message	string	The information about the detection result.	Large amounts of memory resources are used by the Aggregation operator.
Status	string	The severity level of the detection result. Valid values: NORMAL WARNING CRITICAL	WARNING

Examples

Sample success responses

JSONformat

{
  "TotalCount": 566,
  "RequestId": "9DFF5F54-162B-5860-80A5-411FF550B347",
  "DBClusterId": "am-xxx",
  "DetectionItems": [
    {
      "Name": "Metric detection",
      "Results": {
        "OperatorDetails": [
          {
            "MetricName": "PeakMemory",
            "SearchResults": [
              {
                "ProcessId": 2.024080110010002e+36,
                "StageId": "Stage[3]",
                "OperatorName": "Join",
                "PeakMemory": 234,
                "OperatorCost": 123,
                "InputRows": 123,
                "OutputRows": 2345,
                "InputSize": 345,
                "OutputSize": 234,
                "OperatorInfo": "GROUP BY field: uid"
              }
            ]
          }
        ],
        "OperatorAgg": [
          {
            "MetricName": "OperatorCost",
            "SearchResults": [
              {
                "OperatorName": "Window",
                "MaxValue": 2345,
                "TotalValue": 345,
                "AvgValue": 234,
                "OperatorCount": 3
              }
            ]
          }
        ]
      },
      "Message": "Large amounts of memory resources are used by the Aggregation operator.",
      "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.