DescribeDBClusterResourcePoolPerformance - AnalyticDB - Alibaba Cloud Documentation Center

Queries the monitoring information about resource groups within an AnalyticDB for MySQL cluster.

Operation description

Note You can also view the monitoring information about resource groups within an AnalyticDB for MySQL cluster in elastic mode for Cluster Edition in the form of graphs in the console. For more information, see View monitoring information.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- The required resource types are displayed in bold characters.
- 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:DescribeDBClusterResourcePoolPerformance	get	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.	am-****************
Key	string	No	The metrics of the resource group. You can enter multiple metrics at the same time to query the monitoring information. Separate multiple metrics with commas (,). Valid values: AnalyticDB_RP_CPU: the average CPU utilization. Unit: %. AnalyticDB_RP_RT: the query response time (RT). Unit: milliseconds. AnalyticDB_RP_QPS: the queries per second (QPS). The value of this parameter must be a numeric value. AnalyticDB_RP_WaitTime: the query waiting time. Unit: milliseconds. AnalyticDB_RP_OriginalNode: the number of basic nodes in the resource group. AnalyticDB_RP_ActualNode: the number of scheduled nodes that are scaled out in the resource group. AnalyticDB_RP_PlanNode: the number of scheduled nodes to be scaled out in the resource group. AnalyticDB_RP_TotalNode: the total number of nodes in the resource group. Total number of nodes = Number of basic nodes + Number of scheduled nodes that are scaled out. Note If you leave this parameter empty, the monitoring information about all metrics is returned. For more information about scaling plans, see Create a resource scaling plan.	AnalyticDB_RP_CPU
ResourcePools	string	No	The names of the resource groups that you want to query. You can enter multiple names of resource groups. Separate multiple names with commas (,). Note The value of this parameter is case-insensitive. For example, `USER_DEFAULT` and `user_default` specify the same resource group. If you leave this parameter empty, the monitoring information about the `USER_DEFAULT` resource group is returned.	TEST_POOL
StartTime	string	Yes	The beginning of the time range to monitor the resource group. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Note You can view only the monitoring information about the resource groups within the last two days.	2021-06-10T07:00Z
EndTime	string	Yes	The end of the time range to monitor the resource group. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.	2021-06-10T07:01Z

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
EndTime	string	The end of the time range for monitoring the resource group. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-06-10T07:01:00Z
RequestId	string	The request ID.	C7EDB8E4-9769-4233-88C7-DCA4C9******
StartTime	string	The beginning of the time range for monitoring the resource group. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-06-10T07:00:00
DBClusterId	string	The cluster ID.	am-****************
Performances	array<object>	The queried monitoring information about the metrics.
	object	The queried monitoring information about the metric.
Key	string	The metric of the resource group.	AnalyticDB_RP_CPU
Unit	string	The unit of the metric value.	%
ResourcePoolPerformances	array<object>	The queried monitoring information about the resource groups.
	object	The queried monitoring information about the resource group.
ResourcePoolName	string	The name of the resource group.	test_pool
ResourcePoolSeries	array<object>	The sequential monitoring information about the resource groups.
	object	The sequential monitoring information about the resource group.
Values	array	The value of the metric.
	string	The values of the metric at different points in time.	["2021-06-10T07:00:22.601Z","0.0000"],["2021-06-10T07:00:52.62Z","0.0312"]
Name	string	The name of the metric.	cpu

Examples

Sample success responses

JSONformat

{
  "EndTime": "2021-06-10T07:01:00Z",
  "RequestId": "C7EDB8E4-9769-4233-88C7-DCA4C9******",
  "StartTime": "2021-06-10T07:00:00",
  "DBClusterId": "am-****************",
  "Performances": [
    {
      "Key": "AnalyticDB_RP_CPU",
      "Unit": "%",
      "ResourcePoolPerformances": [
        {
          "ResourcePoolName": "test_pool",
          "ResourcePoolSeries": [
            {
              "Values": [
                "[\"2021-06-10T07:00:22.601Z\",\"0.0000\"],[\"2021-06-10T07:00:52.62Z\",\"0.0312\"]"
              ],
              "Name": "cpu"
            }
          ]
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	The specified StartTime is invalid.	The specified StarTime parameter is invalid.
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.

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

Change history

Change time	Summary of changes	Operation
2023-04-06	The Error code has changed	View Change Details