Query performance data using DescribeDBClusterPerformance - AnalyticDB

Queries the performance data of a cluster.

Operation description

For the service endpoint, see Endpoints.

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

list

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the Data Lakehouse Edition cluster. Note You can call the DescribeDBClusters operation to view the IDs of all clusters in the destination region.	amv-bp1hx5n1o8f61****
Key	string	No	The keys of the performance metrics that you want to query. Separate multiple keys with commas (,). For more information about supported metrics, see Overview of metrics.	AnalyticDB_CPU_Usage_Percentage
StartTime	string	No	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.	2022-03-10T23:56Z
EndTime	string	No	The end of the time range to query. Specify the time 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 time range cannot exceed two days.	2022-03-11T15:01Z
RegionId	string	Yes	The region ID. Note Call the DescribeRegions operation to query the information about regions and zones that are supported by AnalyticDB for MySQL, including region IDs.	cn-hangzhou
ResourcePools	string	No	The resource group.	user_default

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range that was queried. The time is in the yyyy-MM-ddTHH:mmZ format and is displayed in UTC.	2022-03-11T15:01Z
RequestId	string	The request ID.	BD8C3096-8BC6-51DF-A4AB-BACD9DC10435
StartTime	string	The beginning of the time range that was queried. The time is in the yyyy-MM-ddTHH:mmZ format and is displayed in UTC.	2022-03-10T23:56Z
DBClusterId	string	The cluster ID. Note Call the DescribeDBClusters operation to query the IDs of all clusters in a specific region.	amv-bp1hx5n1o8f61****
Performances	array<object>	The list of cluster performance metrics.
	array<object>	List.
Key	string	The name of the performance metric.	AnalyticDB_CPU_Usage_Percentage
Unit	string	The unit of the metric.	%
Series	array<object>	The list of performance data.
	object	List.
Values	array	The details about the performance values at different points in time.
	string	The details about the performance values at different points in time.	[ [ "2023-06-27T13:21:00+08:00","0.1250" ], [ "2022-03-11T10:00:42.739Z","0.3125" ]... ]
Name	string	The name of the performance metric. This is the value name of the monitoring metric. For more information, see Overview of metrics.	AnalyticDB_Storage_CPU_Avg_Usage_Percentage
Tags	string	The tag value.	{instance_name: "am-***"}
TranslateKey	string

Examples

Success response

JSON format

{
  "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-***\"}",
          "TranslateKey": ""
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.