Use DescribeDBClusterResourcePoolPerformance to query resource group performance - AnalyticDB - Alibaba Cloud - AnalyticDB

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

Operation description

Note

You can also view resource group monitoring information for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition as graphs in the console. For more information, see View monitoring information.

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

get

DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query all AnalyticDB for MySQL clusters in a region, including cluster IDs.	am-****************
Key	string	No	The metrics of the resource group. You can specify multiple metrics separated by 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). 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 to query. You can specify multiple names separated by 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 start of the time range to query. Specify the time in ISO 8601 format: yyyy-MM-ddTHH:mmZ (UTC). Note Only monitoring data from the last two days is available.	2021-06-10T07:00Z
EndTime	string	Yes	The end of the time range to query. Must be later than the start time. Specify the time in ISO 8601 format: yyyy-MM-ddTHH:mmZ (UTC).	2021-06-10T07:01Z

Response elements

Element	Type	Description	Example
	object	The response parameters.
EndTime	string	The end of the monitoring time range, in ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2021-06-10T07:01:00Z
RequestId	string	The request ID.	C7EDB8E4-9769-4233-88C7-DCA4C9******
StartTime	string	The start of the monitoring time range, in ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2021-06-10T07:00:00
DBClusterId	string	The cluster ID.	am-****************
Performances	array<object>	The monitoring information about the metrics.
	array<object>	The monitoring information about a metric.
Key	string	The metric of the resource group.	AnalyticDB_RP_CPU
Unit	string	The unit of the metric value.	%
ResourcePoolPerformances	array<object>	The monitoring information about the resource groups.
	array<object>	The monitoring information about a resource group.
ResourcePoolName	string	The name of the resource group.	test_pool
ResourcePoolSeries	array<object>	The time-series monitoring data for the resource groups.
	object	The time-series monitoring data for a resource group.
Values	array	The value of the metric.
	string	The metric values 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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.