Queries the average and maximum values of key performance metrics such as CPU utilization, disk IOPS, and disk I/O throughput in the health report of an AnalyticDB for MySQL cluster for a specified date.

For more information about health reports, see Daily health reports.

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 DescribeDBClusterHealthReport

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

StartTime String Yes 2021-08-30

The date to query. Specify the time in the yyyy-MM-dd format. The time must be in UTC.

Note Only data for the last 30 days can be queried.
DBClusterId String Yes am-****************

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query the details of all AnalyticDB for MySQL clusters within a specified region, including cluster IDs.
RegionId String Yes cn-hangzhou

The ID of the region.

Note You can call the DescribeRegions operation to query the regions and zones supported by AnalyticDB for MySQL, including region IDs.

Response parameters

Parameter Type Example Description
Items Array of Items

Details about the key performance metrics in a health report.

Key String Query

The dimension of the performance metric. Valid values:

  • Query: query
  • INSERT: write
  • CPU: CPU utilization
  • DiskUsage: disk usage
  • IOPS: disk IOPS
  • IOThroughput: disk I/O throughput
  • IOAwait: disk I/O wait time
Max String 0

The maximum value of the performance metric.

Name String QPS

The name of the performance metric. Valid values:

  • QPS: the queries per second.
  • RT: This metric takes on different meanings in different dimensions.
    • When Key is set to Query, RT indicates the query response time. Unit: milliseconds.
    • When Key is set to INSERT, RT indicates the write response time. Unit: milliseconds.
  • TPS: the write transactions per second.
  • DATA: the amount of data written per second. Unit: byte/s.
  • WORKER: the CPU utilization of the storage node. Unit: %.
  • EXECUTOR: the CPU utilization of the compute node. Unit: %.
  • RC: the CPU utilization of the frontend node. Unit: %.
  • DiskUsage: the total disk usage. Unit: %.
  • READ: This metric takes on different meanings in different dimensions.
    • When Key is set to IOPS, READ indicates the average disk read operations per second.
    • When Key is set to IOThroughput, READ indicates the average disk read throughput per second. Unit: KB.
  • WRITE: This metric takes on different meanings in different dimensions.
    • When Key is set to IOPS, WRITE indicates the average disk write operations per second.
    • When Key is set to IOThroughput, WRITE indicates the average disk write throughput per second. Unit: KB.
  • When Key is set to IOAwait, WRITE indicates the disk I/O wait time. Unit: milliseconds.
Avg String 0

The average value of the performance metric.

RequestId String 4ED0E20D-A1BD-56DC-8122-B20D44******

The ID of the request.

Examples

Sample requests

http(s)://adb.aliyuncs.com/?Action=DescribeDBClusterHealthReport
&StartTime=2021-08-30
&DBClusterId=am-****************
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDBClusterHealthReportResponse>
    <RequestId>4ED0E20D-A1BD-56DC-8122-B20D44******</RequestId>
    <Items>
        <Avg>0</Avg>
        <Max>0</Max>
        <Key>Query</Key>
        <Name>QPS</Name>
    </Items>
    <Items>
        <Avg>4</Avg>
        <Max>426</Max>
        <Key>Query</Key>
        <Name>RT</Name>
    </Items>
    <Items>
        <Avg>0</Avg>
        <Max>0</Max>
        <Key>INSERT</Key>
        <Name>TPS</Name>
    </Items>
    <Items>
        <Avg>0</Avg>
        <Max>1</Max>
        <Key>INSERT</Key>
        <Name>RT</Name>
    </Items>
    <Items>
        <Avg>0</Avg>
        <Max>1</Max>
        <Key>INSERT</Key>
        <Name>DATA</Name>
    </Items>
    <Items>
        <Avg>0</Avg>
        <Max>4</Max>
        <Key>CPU</Key>
        <Name>WORKER</Name>
    </Items>
    <Items>
        <Avg>0</Avg>
        <Max>0</Max>
        <Key>CPU</Key>
        <Name>EXECUTOR</Name>
    </Items>
    <Items>
        <Avg>0</Avg>
        <Max>0</Max>
        <Key>CPU</Key>
        <Name>RC</Name>
    </Items>
    <Items>
        <Avg>12.59</Avg>
        <Max>12.6</Max>
        <Key>DiskUsage</Key>
        <Name>DiskUsage</Name>
    </Items>
    <Items>
        <Avg>0</Avg>
        <Max>0</Max>
        <Key>IOPS</Key>
        <Name>READ</Name>
    </Items>
    <Items>
        <Avg>0</Avg>
        <Max>3</Max>
        <Key>IOPS</Key>
        <Name>WRITE</Name>
    </Items>
    <Items>
        <Avg>9</Avg>
        <Max>4095</Max>
        <Key>IOThroughput</Key>
        <Name>READ</Name>
    </Items>
    <Items>
        <Avg>252</Avg>
        <Max>19114</Max>
        <Key>IOThroughput</Key>
        <Name>WRITE</Name>
    </Items>
    <Items>
        <Avg>0</Avg>
        <Max>0</Max>
        <Key>IOAwait</Key>
        <Name>IOAwait</Name>
    </Items>
</DescribeDBClusterHealthReportResponse>

JSON format

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

{
  "RequestId" : "4ED0E20D-A1BD-56DC-8122-B20D44******",
  "Items" : [ {
    "Avg" : "0",
    "Max" : "0",
    "Key" : "Query",
    "Name" : "QPS"
  }, {
    "Avg" : "4",
    "Max" : "426",
    "Key" : "Query",
    "Name" : "RT"
  }, {
    "Avg" : "0",
    "Max" : "0",
    "Key" : "INSERT",
    "Name" : "TPS"
  }, {
    "Avg" : "0",
    "Max" : "1",
    "Key" : "INSERT",
    "Name" : "RT"
  }, {
    "Avg" : "0",
    "Max" : "1",
    "Key" : "INSERT",
    "Name" : "DATA"
  }, {
    "Avg" : "0",
    "Max" : "4",
    "Key" : "CPU",
    "Name" : "WORKER"
  }, {
    "Avg" : "0",
    "Max" : "0",
    "Key" : "CPU",
    "Name" : "EXECUTOR"
  }, {
    "Avg" : "0",
    "Max" : "0",
    "Key" : "CPU",
    "Name" : "RC"
  }, {
    "Avg" : "12.59",
    "Max" : "12.6",
    "Key" : "DiskUsage",
    "Name" : "DiskUsage"
  }, {
    "Avg" : "0",
    "Max" : "0",
    "Key" : "IOPS",
    "Name" : "READ"
  }, {
    "Avg" : "0",
    "Max" : "3",
    "Key" : "IOPS",
    "Name" : "WRITE"
  }, {
    "Avg" : "9",
    "Max" : "4095",
    "Key" : "IOThroughput",
    "Name" : "READ"
  }, {
    "Avg" : "252",
    "Max" : "19114",
    "Key" : "IOThroughput",
    "Name" : "WRITE"
  }, {
    "Avg" : "0",
    "Max" : "0",
    "Key" : "IOAwait",
    "Name" : "IOAwait"
  } ]
}

Error codes

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