DescribeDBClusterPerformance - AnalyticDB - Alibaba Cloud Documentation Center

Queries the performance data of an AnalyticDB for MySQL cluster.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

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

There is currently no authorization information disclosed in the API.

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 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_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

Parameter	Type	Description	Example
	object
EndTime	string	The end time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.	2022-03-11T15:01Z
RequestId	string	The request ID.	BD8C3096-8BC6-51DF-A4AB-BACD9DC10435
StartTime	string	The start time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.	2022-03-10T23:56Z
DBClusterId	string	The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.	amv-bp1hx5n1o8f61****
Performances	array<object>	The queried performance metrics.
PerformanceItem	object	The queried performance metric.
Key	string	The name of the performance metric.	AnalyticDB_CPU_Usage_Percentage
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 performance metric at different points in time.
Values	string	The value of the performance metric at a specific point 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 value. For more information about the performance metrics, see Metric overview.	AnalyticDB_Storage_CPU_Avg_Usage_Percentage
Tags	string	The tags that are added to the cluster.	{instance_name: "am-***"}

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

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