DescribeControllerDetection API Overview for Access Layer Diagnostics - AnalyticDB for MySQL - Alibaba Cloud - AnalyticDB

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:DescribeControllerDetection

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 IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a region.	amv-xxxx
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-beijing
StartTime	string	No	The start of the time range to query. Specify the time in ISO 8601 format: yyyy-MM-ddTHH:mmZ (UTC).	2021-05-03T15:00Z
EndTime	string	No	The end of the time range to query. Specify the time in ISO 8601 format: yyyy-MM-ddTHH:mmZ (UTC). Note The end time must be later than the start time.	2024-06-23T02:21Z
Lang	string	No	The language. Valid values: en: simplified Chinese. en: English.	en

Response elements

Element	Type	Description	Example
	object
TotalCount	string	The total number of entries returned.	8
RequestId	string	The request ID.	D9856CFD-10DC-50AF-AE29-07C30FC57B86
DBClusterId	string	The cluster ID.	amv-xxx
DetectionItems	array<object>	The detection items and results.
	object	A detection item and its result.
Message	string	The detection result details.	Detected CPU spike on the access node.
Name	string	The name of the detection item.	CPUincrease detection
Status	string	The severity level of the detection result. Valid values: NORMAL WARNING CRITICAL	NORMAL WARNING CRITICAL

Examples

Success response

JSON format

{
  "TotalCount": "8",
  "RequestId": "D9856CFD-10DC-50AF-AE29-07C30FC57B86",
  "DBClusterId": "amv-xxx",
  "DetectionItems": [
    {
      "Message": "Detected CPU spike on the access node.",
      "Name": "CPUincrease 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.