DescribeDBClusterPerformance - AnalyticDB - Alibaba Cloud Documentation Center

Queries the performance data of an AnalyticDB for MySQL cluster.

Operation description

You can call this operation to query the performance data of a cluster over a time range based on its performance metrics. The data is collected every 30 seconds. This operation allows you to query information about slow queries, such as the SQL query duration, number of scanned rows, and amount of scanned data.

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:DescribeDBClusterPerformance	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL clusters within a region.	am-************
Key	string	Yes	The key of the performance metric that you want to query. Separate multiple keys with commas (,). For more information about the performance metrics, see Metric overview.	AnalyticDB_CPU
StartTime	string	Yes	The start time of the query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.	2021-05-03T15:00Z
EndTime	string	Yes	The end time of the 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 two days.	2021-05-03T15:01Z
RegionId	string	Yes	The region ID of the cluster.	cn-hangzhou
ResourcePools	string	No	The name of the resource group.	test

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
EndTime	string	The end time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-05-03T15:01:00Z
RequestId	string	The request ID.	25B56BC7-4978-40B3-9E48-4B7067******
StartTime	string	The start time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-05-03T15:00:00Z
DBClusterId	string	The cluster ID.	am-************
Performances	array<object>	The queried performance metrics.
PerformanceItem	object	The queried performance metric.
Key	string	The name of the performance metric.	AnalyticDB_CPU
Unit	string	The unit of the performance metric.	%
Series	array<object>	The queried performance metric data.
SeriesItem	object	The queried performance metric data.
Values	array	The values of the queried performance metric.
Values	string	The value of the performance metric at a specific point in time.	[ "2021-05-03T15:00:12.72Z", "0.1250" ], [ "2021-05-03T15:00:42.739Z", "0.3125" ]
Name	string	The name of the performance metric value. For more information about the performance metrics, see Metric overview.	worker_avg_cpu_used
Tags	string	The tags that are added to the cluster.	instance_name: "amv-8vbf80pjcz*****"
TranslateKey	string	The key that is used to obtain the name of the performance metric value.	elastic_executor_avg_cpu_use
AccessDeniedDetail	string	The information about the request denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.	{ "AuthAction": "xxx", "AuthPrincipalDisplayName": "sampleName", "AuthPrincipalOwnerId": "111111111111111111", "AuthPrincipalType": "SubUser", "AuthResource": "xxx", "NoPermissionType": "xxx", "PolicyType": "xxx" }

Examples

Sample success responses

JSONformat

{
  "EndTime": "2021-05-03T15:01:00Z",
  "RequestId": "25B56BC7-4978-40B3-9E48-4B7067******",
  "StartTime": "2021-05-03T15:00:00Z",
  "DBClusterId": "am-************",
  "Performances": [
    {
      "Key": "AnalyticDB_CPU",
      "Unit": "%",
      "Series": [
        {
          "Values": [
            "[               \"2021-05-03T15:00:12.72Z\",               \"0.1250\"             ],             [               \"2021-05-03T15:00:42.739Z\",               \"0.3125\"             ]"
          ],
          "Name": "worker_avg_cpu_used",
          "Tags": "instance_name: \"amv-8vbf80pjcz*****\"",
          "TranslateKey": "elastic_executor_avg_cpu_use"
        }
      ]
    }
  ],
  "AccessDeniedDetail": "{\n  \"AuthAction\": \"xxx\",\n  \"AuthPrincipalDisplayName\": \"sampleName\",\n  \"AuthPrincipalOwnerId\": \"111111111111111111\",\n  \"AuthPrincipalType\": \"SubUser\",\n  \"AuthResource\": \"xxx\",\n  \"NoPermissionType\": \"xxx\",\n  \"PolicyType\": \"xxx\"\n}"
}

Error codes

HTTP status code	Error code	Error message
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-11-08	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-10	API Description Update. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-04-06	The Error code has changed	View Change Details