DescribeControllerDetection - AnalyticDB - Alibaba Cloud Documentation Center

Queries the diagnostic results of the access 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:DescribeControllerDetection	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.	amv-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	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.	2022-03-10T23:56Z
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. Note The end time must be later than the start time. The maximum time range that can be specified is 30 days.	2024-06-23T02:21Z
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.	10
RequestId	string	The request ID.	257FAE29-ED5F-586C-94E4-43BD1392F238
DBClusterId	string	The cluster ID.	amv-xxx
DetectionItems	array<object>	The queried detection items and detection results.
BaseDetectionItem	object	The queried detection item and detection result.
Message	string	The information about the detection result.	A CPU increase is detected on the access node.
Name	string	The name of the detection item.	CPU increase detection
Status	string	The severity level of the detection result. Valid values: NORMAL WARNING CRITICAL	NORMAL WARNING CRITICAL

Examples

Sample success responses

JSONformat

{
  "TotalCount": 10,
  "RequestId": "257FAE29-ED5F-586C-94E4-43BD1392F238",
  "DBClusterId": "amv-xxx",
  "DetectionItems": [
    {
      "Message": "A CPU increase is detected on the access node.",
      "Name": "CPU increase detection",
      "Status": "NORMAL\nWARNING\nCRITICAL"
    }
  ]
}

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.