文档

DescribeDBClusterPerformance - 查看集群性能数据

更新时间:

调用DescribeDBClusterPerformance接口查看目标集群的性能数据。

接口说明

根据性能参数查看某个集群、某时间段范围内的性能监控数据。采集粒度为 30 秒。支持对慢 SQL 进行查询,提供 SQL 查询时长、扫描行数、扫描量等监控内容。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeDBClusterPerformanceList
  • DBClusterLakeVersion
    acs:adb:{#Region}:{#AccountId}:dbcluster/{#DBClusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

AnalyticDB MySQL 版集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 版集群的详情,包括集群 ID。
am-8vbf80pjcz*****
Keystring

需要查询的性能指标名称,多个值之间用英文逗号(,)分隔。支持查询如下性能指标:

  • CPU
    • AnalyticDB_CPU:CPU 平均使用率。
  • 连接数
    • AnalyticDB_Connections:数据库连接数。
  • 写入
    • AnalyticDB_TPS:写入 TPS。
    • AnalyticDB_InsertRT:写入响应时间。
    • AnalyticDB_InsertBytes:写入吞吐量。
  • 更新
    • AnalyticDB_UpdateRT:更新响应时间。
  • 删除
    • AnalyticDB_DeleteRT:删除响应时间。
  • 查询
    • AnalyticDB_QPS:查询 QPS。
    • AnalyticDB_QueryRT:查询响应时间。
    • AnalyticDB_QueryWaitTime:查询等待耗时。
  • 磁盘
    • AnalyticDB_IO:磁盘 IO 吞吐。
    • AnalyticDB_IO_UTIL:IO Util。
    • AnalyticDB_IO_WAIT:IO Wait。
    • AnalyticDB_IOPS:磁盘 IOPS。
    • AnalyticDB_DiskUsage:磁盘用量。
    • AnalyticDB_HotDataDiskUsage:热数据磁盘用量。
    • AnalyticDB_ColdDataDiskUsage:冷数据磁盘用量。
说明 若该参数留空,默认返回上述所有性能指标的值。
AnalyticDB_CPU
StartTimestring

查询开始时间。格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

2021-05-03T15:00Z
EndTimestring

查询结束时间。格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

说明 查询结束时间需晚于开始时间,且开始时间和结束时间的时间间隔不能超过两天。
2021-05-03T15:01Z
RegionIdstring

集群所在的地域。

cn-hangzhou
ResourcePoolsstring

资源组名称。

test

返回参数

名称类型描述示例值
object

列表详情。

EndTimestring

查询结束时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2021-05-03T15:01:00Z
RequestIdstring

请求 ID。

25B56BC7-4978-40B3-9E48-4B7067******
StartTimestring

查询开始时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2021-05-03T15:00:00Z
DBClusterIdstring

集群 ID。

am-8vbf80pjcz*****
Performancesobject []

集群性能指标列表。

Keystring

性能指标名称。

AnalyticDB_CPU
Unitstring

数据单位。

%
Seriesobject []

性能数据列表。

Valuesarray

性能指标数值详情。

string

不同时间点下的性能值详情。

[ "2021-05-03T15:00:12.72Z", "0.1250" ], [ "2021-05-03T15:00:42.739Z", "0.3125" ]
Namestring

性能值名称。

worker_avg_cpu_used
Tagsstring

标签。

instance_name: "amv-8vbf80pjcz*****"

示例

正常返回示例

JSON格式

{
  "EndTime": "2021-05-03T15:01:00Z",
  "RequestId": "25B56BC7-4978-40B3-9E48-4B7067******",
  "StartTime": "2021-05-03T15:00:00Z",
  "DBClusterId": "am-8vbf80pjcz*****",
  "Performances": [
    {
      "Key": "AnalyticDB_CPU",
      "Unit": "%",
      "Series": [
        {
          "Values": [
            "[               \"2021-05-03T15:00:12.72Z\",               \"0.1250\"             ],             [               \"2021-05-03T15:00:42.739Z\",               \"0.3125\"             ]"
          ],
          "Name": "worker_avg_cpu_used",
          "Tags": "instance_name: \"amv-8vbf80pjcz*****\""
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

变更历史

变更时间变更内容概要操作
2023-10-10OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:RegionId
    新增入参:ResourcePools
出参OpenAPI 返回结构发生变更
2023-04-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
    新增错误码:403
  • 本页导读 (1)
文档反馈