You can call this operation to query the monitoring information of the resource pool of an AnalyticDB for MySQL elastic cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically 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 rm-uf6wjk5xxxxxxxxxx

The ID of the cluster.

EndTime String Yes 2020-10-19T11:31Z

The end time of the monitoring data. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format.

StartTime String Yes 2020-10-19T11:30Z

The start time of the monitoring data. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format.

Key String No AnalyticDB_CPU

The metric of monitoring data. By default, if you do not specify this parameter, all the metrics are displayed. Separate multiple metrics with commas (,). Valid values:

  • AnalyticDB_RP_CPU: average CPU utilization
    • Property: cpu
    • Unit: %
  • AnalyticDB_RP_RT: the response time of the query
    • Property: rt
    • Unit: ms
  • AnalyticDB_RP_QPS: queries per second (QPS)
    • Property: qps
    • Unit: numeric value
  • AnalyticDB_RP_WaitTime: the waiting time
    • Property: wait_time
    • Unit: ms
  • AnalyticDB_RP_ActualNode: the actual number of time-specific elastic nodes in the resource pool
    • Property: actual_node
    • Unit: numeric value
  • AnalyticDB_RP_PlanNode: the number of time-specific elastic nodes in the resource pool
    • Property: plan_node
    • Unit: numeric value
  • AnalyticDB_RP_TotalNode: the total number of nodes in the resource pool
    • Property: total_node
    • Unit: numeric value
ResourcePools String No source_a

The resource pools used to filter monitoring data. If you do not specify this parameter, the monitoring data of the user_default resource pool is displayed. Separate multiple resource pools with commas (,).

Response parameters

Parameter Type Example Description
DBClusterId String rm-uf6wjk5xxxxxxxxxx

The ID of the cluster.

EndTime String 2020-10-19T11:31Z

The end time of the monitoring data.

Performances Array of PerformanceItem

The list of data to be monitored by metric.

Key String AnalyticDB_CPU

The metric.

ResourcePoolPerformances Array of ResourcePoolPerformancesItem

The list of metrics to be monitored by resource pool.

ResourcePoolName String source_a

The name of the resource pool.

ResourcePoolSeries Array of ResourcePoolSeriesItem

The array of metrics of the resource pool to be monitored by metric property.

Name String cpu

The name of the metric property.

Values List 50

The value of the metric.

Unit String %

The unit of the metric.

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

StartTime String 2020-10-19T11:30Z

The start time of the monitoring data.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeDBClusterResourcePoolPerformance
&DBClusterId=rm-uf6wjk5xxxxxxxxxx
&EndTime=2020-10-19T11:31Z
&StartTime=2020-10-19T11:30Z
&<Common request parameters>

Sample success responses

XML format

<EndTime>2020-10-19T11:31Z</EndTime>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<StartTime>2020-10-19T11:30Z</StartTime>
<DBClusterId>rm-uf6wjk5xxxxxxxxxx</DBClusterId>
<Performances>
    <Unit>%</Unit>
    <Key>AnalyticDB_CPU</Key>
</Performances>
<Performances>
    <ResourcePoolPerformances>
        <ResourcePoolName>source_a</ResourcePoolName>
    </ResourcePoolPerformances>
    <ResourcePoolPerformances>
        <ResourcePoolSeries>
            <Name>cpu</Name>
        </ResourcePoolSeries>
        <ResourcePoolSeries>
            <Values>50</Values>
        </ResourcePoolSeries>
    </ResourcePoolPerformances>
</Performances>

JSON format

{
    "EndTime": "2020-10-19T11:31Z",
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "StartTime": "2020-10-19T11:30Z",
    "DBClusterId": "rm-uf6wjk5xxxxxxxxxx",
    "Performances": [
        {
            "Unit": "%",
            "Key": "AnalyticDB_CPU"
        },
        {
            "ResourcePoolPerformances": [
                {
                    "ResourcePoolName": "source_a"
                },
                {
                    "ResourcePoolSeries": [
                        {
                            "Name": "cpu"
                        },
                        {
                            "Values": 50
                        }
                    ]
                }
            ]
        }
    ]
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId parameter does not exist. Check whether you specify the DBClusterId parameter correctly.

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