Queries the performance data of an AnalyticDB for MySQL cluster.
Operation description
For information about the endpoints of AnalyticDB for MySQL, see Endpoints .
Debugging
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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBClusterId | string | Yes | The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. Note
You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
| amv-bp1hx5n1o8f61**** |
| Key | string | Yes | The performance metrics to be queried. Separate multiple values with commas (,). Valid values:
Note
This parameter must be specified.
| AnalyticDB_CPU_Usage_Percentage |
| 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 two days.
| 2022-03-11T15:01Z |
| RegionId | string | Yes | The region ID of the cluster. Note
You can call the DescribeRegions operation to query the most recent region list.
| cn-hangzhou |
| ResourcePools | string | No | The resource group ID. | user_default |
Response parameters
Examples
Sample success responses
JSONformat
{
"EndTime": "2022-03-11T15:01Z",
"RequestId": "BD8C3096-8BC6-51DF-A4AB-BACD9DC10435",
"StartTime": "2022-03-10T23:56Z",
"DBClusterId": "amv-bp1hx5n1o8f61****",
"Performances": [
{
"Key": "AnalyticDB_CPU_Usage_Percentage",
"Unit": "%",
"Series": [
{
"Values": [
"[\n [ \n \"2023-06-27T13:21:00+08:00\",\"0.1250\" \n ], \n [ \n \"2022-03-11T10:00:42.739Z\",\"0.3125\" \n ]...\n]"
],
"Name": "AnalyticDB_Storage_CPU_Avg_Usage_Percentage",
"Tags": "\n{instance_name: \"am-***\"}"
}
]
}
]
}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 |
|---|---|---|
| 2023-09-13 | The Error code has changed | View Change Details |