You can call this operation to query performance data of a cluster. You can determine the performance of a cluster over a specified time range based on its performance metrics. The performance data is collected in 30-minute intervals.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to DescribeDBClusterPerformance.
DBClusterId String Yes The ID of the cluster.
Key String Yes

The performance metric that you want to query. Separate multiple values with commas (,). A maximum of five metrics can be queried at a time.

Note
  • CPU
    • CPU_USAGE: the CPU utilization.
      • cpu_usage
  • Memory
    • MEM_USAGE: the memory usage.
      • mem_usage
    • MEM_USAGE_SIZE: the amount of memory used. Unit: MB.
      • mem_usage_size
  • Disk
    • DISK_USAGE: the disk usage.
      • disk_usage
    • DISK_USAGE_SIZE: the amount of disk space used.
      • disk_usage_size
    • IOPS: the number of disk input/output operations per second (IOPS).
      • iops
    • IOPS_SIZE: the disk IOPS capacity. Unit: MB.
      • iops_mb
  • Connections
    • CONN_USAGE: the database connection usage.
      • conn_usage
    • CONN_USAGE_COUNT: the number of database connections used.
      • conn_usage_count
  • Write
    • TPS: the number of write transactions per second (TPS).
      • tps
    • INSERT_ROWS: the number of rows written per second.
      • insert_rows
    • INSERT_SIZE: the amount of data written per second. Unit: MB.
      • insert_mb
  • Query
    • QPS: the number of queries processed per second.
      • qps
    • AVG_SEEK: the average number of random seek calls.
      • seek_ps
  • WAIT
    • ZKWAIT: the average ZooKeeper wait time. Unit: ms.
      • zk_wait
    • IO_WAIT
      • io_wait: the average I/O wait time. Unit: ms.
    • CPU_WAIT
      • cpu_wait: the average CPU wait time. Unit: ms.
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.
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.

Response parameters

Parameter Type Description
DBClusterId String The ID of the cluster.
StartTime String The start time of the query.
EndTime String The end time of the query.
Performances Array Details about the performance metrics.
└Key String The performance metric, such as ClickHouse_CPU.
└Unit String The unit of the performance metric.
Series Array Details about the metrics of backend servers.
└Name String The name of the metric, such as serverid.
└Values Array Details about the metric values of backend servers.
└Point String[]

The array format. Example: [

[ "2019-05-06T05:17:46Z", "5.09" ]

RequestId String The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDBClusterPerformance
&DBClusterId=am-xxxxxxxxxx
&StartTime=2019-11-01T00:00Z
&EndTime=2019-11-01T00:05Z
&Key=AnalyticDB_DiskUsage
&<Common request parameters>

Sample success responses

XML format

<DescribeDBClusterPerformanceResponse>
  <EndTime>2020-03-19T07:28Z</EndTime>
  <RequestId>3019120E-125D-4FC0-B286-266A40F84716</RequestId>
  <DBClusterId>cc-t4n1w34v612qa7uk7</DBClusterId>
  <StartTime>2020-03-19T07:26Z</StartTime>
  <Performances>
    <PerformanceItem>
      <Series>
        <SeriesItem>
          <Values>
            <ValueItem>
              <Point>
                <Point>2020-03-19T07:26:00Z</Point>
                <Point>0.29</Point>
              </Point>
            </ValueItem>
            <ValueItem>
              <Point>
                <Point>2020-03-19T07:27:00Z</Point>
                <Point>0.28</Point>
              </Point>
            </ValueItem>
          </Values>
          <Name>cc-t4n1w34v612qa7uk773430</Name>
        </SeriesItem>
        <SeriesItem>
          <Values>
            <ValueItem>
              <Point>
                <Point>2020-03-19T07:26:00Z</Point>
                <Point>0.28</Point>
              </Point>
            </ValueItem>
            <ValueItem>
              <Point>
                <Point>2020-03-19T07:27:00Z</Point>
                <Point>0.21</Point>
              </Point>
            </ValueItem>
          </Values>
          <Name>cc-t4n1w34v612qa7uk773431</Name>
        </SeriesItem>
      </Series>
      <Unit>%</Unit>
      <Key>CPU_USAGE</Key>
      <Name>cpu_usage</Name>
    </PerformanceItem>
  </Performances>
</DescribeDBClusterPerformanceResponse>

JSON format

{
  "EndTime": "2020-03-20T00:02Z",
  "RequestId": "1D1F6CA8-6CB2-47BA-A474-DE8703636002",
  "DBClusterId": "cc-t4n1w34v612qa7uk7",
  "StartTime": "2020-03-20T00:00Z",
  "Performances": [
    {
      "Series": [
        {
          "Values": [
            {
              "Point": [
                "2020-03-20T00:00:00Z",
                "1.01"
              ]
            },
            {
              "Point": [
                "2020-03-20T00:01:00Z",
                "1.0"
              ]
            }
          ],
          "Name": "cc-t4n1w34v612qa7uk773430"
        },
        {
          "Values": [
            {
              "Point": [
                "2020-03-20T00:00:00Z",
                "1.01"
              ]
            },
            {
              "Point": [
                "2020-03-20T00:01:00Z",
                "1.01"
              ]
            }
          ],
          "Name": "cc-t4n1w34v612qa7uk773431"
        }
      ],
      "Unit": "counts",
      "Key": "INSERT_ROWS",
      "Name": "cpu_usage"
    }
  ]
}