调用DescribeDBClusterHealthReport接口查看指定日期内目标AnalyticDB MySQL版集群的健康报告主要性能指标(如CPU使用率、存储磁盘IOPS、存储磁盘IO吞吐等)的平均值和最大值。

关于健康报告的更多详情,请参见每日健康报告

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBClusterHealthReport

系统规定参数。取值:DescribeDBClusterHealthReport

StartTime String 2021-08-30

需要查询的日期,格式为yyyy-MM-dd(UTC时间)。

说明 仅支持查看30天内的数据。
DBClusterId String am-****************

集群ID。

说明 您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL集群的详情,包括集群ID。
RegionId String cn-hangzhou

地域ID。

说明 您可以调用DescribeRegions接口查看AnalyticDB MySQL版支持的地域和可用区信息,包括地域ID。

返回数据

名称 类型 示例值 描述
Items Array of Items

健康报告主要性能指标详情。

Key String Query

性能指标维度。支持查看如下维度:

  • Query:查询。
  • INSERT:写入。
  • CPU:CPU使用率。
  • DiskUsage:磁盘总体水位。
  • IOPS:存储磁盘IOPS。
  • IOThroughput:存储磁盘IO吞吐。
  • IOAwait:存储磁盘IO等待耗时。
Max String 0

当前性能指标的最大值。

Name String QPS

性能指标名称。支持查看如下性能指标:

  • QPS:查询QPS。
  • RT:该性能指标在不同维度下意义不同,其中:
    • Query维度:表示查询响应时间,单位:毫秒。
    • INSERT维度:表示写入响应时间,单位:毫秒。
  • TPS:写入TPS。
  • DATA:写入流量,单位:Byte/s。
  • WORKER:存储节点的CPU使用率,单位:%。
  • EXECUTOR:计算节点的CPU使用率,单位:%。
  • RC:前端节点的CPU使用率,单位:%。
  • DiskUsage:磁盘总使用率,单位:%。
  • READ:该性能指标在不同维度下意义不同,其中:
    • IOPS维度:表示存储磁盘的每秒读取次数。
    • IOThroughput维度:表示存储磁盘的每秒读取量,单位:KB。
  • WRITE:该性能指标在不同维度下意义不同,其中:
    • IOPS维度:表示存储磁盘的每秒写入次数。
    • IOThroughput维度:表示存储磁盘的每秒写入量,单位:KB。
  • IOAwait:存储磁盘IO等待耗时,单位:毫秒。
Avg String 0

当前性能指标的平均值。

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

请求ID。

示例

请求示例

http(s)://adb.aliyuncs.com/?Action=DescribeDBClusterHealthReport
&StartTime=2021-08-30
&DBClusterId=am-****************
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

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格式

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"
  } ]
}

错误码

访问错误中心查看更多错误码。