Queries the monitoring information of resource pools within an AnalyticDB for MySQL cluster in elastic mode for Cluster Edition.

Note You can also view the monitoring information of resource pools 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 of resource pools.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBClusterResourcePoolPerformance

The operation that you want to perform. Set the value to DescribeDBClusterResourcePoolPerformance.

DBClusterId String Yes am-****************

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query details about all AnalyticDB for MySQL clusters in a specific region, including cluster IDs.
Key String No AnalyticDB_RP_CPU

The metric of the resource pool. 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_ActualNode: the number of time-specific nodes that are scaled out in the resource pool. The value of this parameter must be a numeric value.
  • AnalyticDB_RP_PlanNode: the number of time-specific nodes to be scaled out in the resource pool. The value of this parameter must be a numeric value.
  • AnalyticDB_RP_TotalNode: the total number of nodes in the resource pool. Total number of nodes = Number of basic nodes + Number of time-specific nodes that are scaled out. The value of this parameter must be a numeric value.
  • AnalyticDB_RP_OriginalNode: the number of basic nodes in the resource pool. The value of this parameter must be a numeric value.
Note
  • If this parameter is left empty, the monitoring information of all metrics is returned.
  • For more information about elastic plans, see Scale out resources.
ResourcePools String No TEST_POOL

The names of the resource pools that you want to monitor. You can enter multiple names of resource pools. Separate multiple names with commas (,).

Note
  • The value of this parameter is case-insensitive. For example, USER_DEFAULT and user_default indicate the same resource pool.
  • If this parameter is left empty, the monitoring information of the USER_DEFAULT resource pool is returned.
StartTime String Yes 2021-06-10T07:00Z

The beginning of the time range to monitor the resource pool. 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 of the resource pools for the last two days.
EndTime String Yes 2021-06-10T07:01Z

The end of the time range to monitor the resource pool. 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.

Response parameters

Parameter Type Example Description
EndTime String 2021-06-10T07:01:00Z

The end of the time range to monitor the resource pool. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

RequestId String C7EDB8E4-9769-4233-88C7-DCA4C9******

The ID of the request.

StartTime String 2021-06-10T07:00:00

The beginning of the time range to monitor the resource pool. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

DBClusterId String am-****************

The ID of the cluster.

Performances Array of PerformanceItem

Details about the monitoring information of the metric.

Key String AnalyticDB_RP_CPU

The metric of the resource pool.

Unit String %

The unit of the metric.

ResourcePoolPerformances Array of ResourcePoolPerformancesItem

Details about the monitoring information of the resource pool.

ResourcePoolName String test_pool

The name of the resource pool.

ResourcePoolSeries Array of ResourcePoolSeriesItem

Details about the sequential monitoring information.

Values Array of String ["2021-06-10T07:00:22.601Z","0.0000"],["2021-06-10T07:00:52.62Z","0.0312"]

The values of the metric at different points in time.

Name String cpu

The name of the metric.

Examples

Sample requests

http(s)://adb.aliyuncs.com/?Action=DescribeDBClusterResourcePoolPerformance
&DBClusterId=am-****************
&StartTime=2021-06-10T07:00Z
&EndTime=2021-06-10T07:01Z
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClusterResourcePoolPerformanceResponse>
    <RequestId>C7EDB8E4-9769-4233-88C7-DCA4C9******</RequestId>
    <EndTime>2021-06-10T07:01:00Z</EndTime>
    <StartTime>2021-06-10T07:00:00Z</StartTime>
    <Performances>
        <ResourcePoolPerformances>
            <ResourcePoolSeries>
                <Values>
                    <0>2021-06-10T07:00:22.601Z</0>
                    <1>0.0000</1>
                </Values>
                <Values>
                    <0>2021-06-10T07:00:52.62Z</0>
                    <1>0.0312</1>
                </Values>
                <Name>cpu</Name>
            </ResourcePoolSeries>
            <ResourcePoolName>test_pool</ResourcePoolName>
        </ResourcePoolPerformances>
        <Unit>%</Unit>
        <Key>AnalyticDB_RP_CPU</Key>
    </Performances>
</DescribeDBClusterResourcePoolPerformanceResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified cluster ID does not exist. Check whether the cluster ID is valid.

For a list of error codes, visit the API Error Center.