You can call this operation to query the performance data of an AnalyticDB for MySQL cluster.

You can query the performance of an cluster over a specific time range based on its performance metrics. The collection granularity is 30 seconds. This operation allows you to query data of slow SQL queries such as the SQL query duration, number of scanned rows, and scanned volume.

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 DescribeDBClusterPerformance

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

DBClusterId String Yes rm-uf6wjk5xxxxxxxxxx

The ID of the cluster.

EndTime String Yes 2012-06-18T15:00Z

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

StartTime String Yes 2012-06-08T15:00Z

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Key String No AnalyticDB_DiskUsage

The performance metrics to be queried. Separate multiple values with commas (,). If you do not specify a key value, the following metrics are returned:

  • CPU

    AnalyticDB_CPU: the average CPU utilization.

  • Connections

    AnalyticDB_Connections: the number of database connections.

  • Write
    • AnalyticDB_TPS: the write transactions per second (TPS).
    • AnalyticDB_InsertRT: the write response time.
    • AnalyticDB_InsertBytes: the write throughout.
  • Query
    • AnalyticDB_QPS: the queries per second (QPS).
    • AnalyticDB_QueryRT: the query response time.
    • AnalyticDB_QueryWaitTime: the query wait time.
  • Disk
    • AnalyticDB_IO: the disk I/O throughput.
    • AnalyticDB_IOPS: the disk input/output operations per second (IOPS).
    • AnalyticDB_DiskUsage: the disk usage.
    • AnalyticDB_HotDataDiskUsage: the disk usage of hot data.
    • AnalyticDB_ColdDataDiskUsage: the disk usage of cold data.

Response parameters

Parameter Type Example Description
DBClusterId String rm-uf6wjk5xxxxxxxxxx

The ID of the cluster.

EndTime String 2012-06-18T15:00Z

The end time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

Performances Array of PerformanceItem

Details about the performance metrics.

Key String AnalyticDB_DiskUsage

The performance metric.

Series Array of SeriesItem

The list of cluster performance metric.

Name String disk_used

The name of the performance metric.

Values List [ [ "2019-05-06T05:17:46.487Z", 5 ], [ "2019-05-06T05:18:20.784Z", 5 ] ]

The values of the performance metric, which are in the array format.

Unit String %

The unit of the performance data.

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

The ID of the request.

StartTime String 2012-06-08T15:00Z

The beginning time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeDBClusterPerformance
&DBClusterId=rm-uf6wjk5xxxxxxxxxx
&EndTime=2012-06-18T15:00Z
&StartTime=2012-06-08T15:00Z
&<Common request parameters>

Sample success responses

XML format

<Performances>
    <Key>AnalyticDB_DiskUsage</Key>
    <Series>
        <Values>
            <0>2019-11-11T00:00:27.862Z</0>
            <1>3.0026</1>
        </Values>
        <Values>
            <0>2019-11-11T00:00:57.867Z</0>
            <1>3.0026</1>
        </Values>
        <Values>
            <0>2019-11-11T00:01:27.873Z</0>
            <1>3.0026</1>
        </Values>
        <Values>
            <0>2019-11-11T00:01:57.878Z</0>
            <1>3.0026</1>
        </Values>
        <Values>
            <0>2019-11-11T00:02:27.884Z</0>
            <1>3.0026</1>
        </Values>
        <Values>
            <0>2019-11-11T00:02:57.889Z</0>
            <1>3.0026</1>
        </Values>
        <Values>
            <0>2019-11-11T00:03:27.896Z</0>
            <1>3.0026</1>
        </Values>
        <Values>
            <0>2019-11-11T00:03:57.901Z</0>
            <1>3.0026</1>
        </Values>
        <Values>
            <0>2019-11-11T00:04:27.907Z</0>
            <1>3.0026</1>
        </Values>
        <Values>
            <0>2019-11-11T00:04:57.912Z</0>
            <1>3.0026</1>
        </Values>
        <Name>disk_used</Name>
    </Series>
    <Unit>%</Unit>
</Performances>
<RequestId>2271ADDE-1F5A-4501-8683-1667DF90504E</RequestId>
<EndTime>2019-11-11T00:05:00Z</EndTime>
<StartTime>2019-11-11T00:00:00Z</StartTime>

JSON format

{
    "Performances": {
        "Key": "AnalyticDB_DiskUsage",
        "Series": {
            "Values": [
                {
                    "0": "2019-11-11T00:00:27.862Z",
                    "1": 3.0026
                },
                {
                    "0": "2019-11-11T00:00:57.867Z",
                    "1": 3.0026
                },
                {
                    "0": "2019-11-11T00:01:27.873Z",
                    "1": 3.0026
                },
                {
                    "0": "2019-11-11T00:01:57.878Z",
                    "1": 3.0026
                },
                {
                    "0": "2019-11-11T00:02:27.884Z",
                    "1": 3.0026
                },
                {
                    "0": "2019-11-11T00:02:57.889Z",
                    "1": 3.0026
                },
                {
                    "0": "2019-11-11T00:03:27.896Z",
                    "1": 3.0026
                },
                {
                    "0": "2019-11-11T00:03:57.901Z",
                    "1": 3.0026
                },
                {
                    "0": "2019-11-11T00:04:27.907Z",
                    "1": 3.0026
                },
                {
                    "0": "2019-11-11T00:04:57.912Z",
                    "1": 3.0026
                }
            ],
            "Name": "disk_used"
        },
        "Unit": "%"
    },
    "RequestId": "2271ADDE-1F5A-4501-8683-1667DF90504E",
    "EndTime": "2019-11-11T00:05:00Z",
    "StartTime": "2019-11-11T00:00:00Z"
}

Error codes

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