DescribeDBClusterPerformance - 查看集群性能数据

更新时间:2025-02-26 07:29:25

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
adb:DescribeDBClusterPerformancelist
*全部资源
*

请求参数

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

AnalyticDB MySQL 版集群 ID。

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

需要查询的性能指标名称(监控项 Key),多个值之间用英文逗号(,)分隔。支持查询的指标详情请参见监控项概览

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*****
Performancesarray<object>

集群性能指标列表。

PerformanceItemobject

列表。

Keystring

性能指标名称。

AnalyticDB_CPU
Unitstring

数据单位。

%
Seriesarray<object>

性能数据列表。

SeriesItemobject

列表。

Valuesarray

性能指标数值详情。

Valuesstring

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

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

性能指标名称(监控指标 Value Name)。指标详情请参见监控项概览

worker_avg_cpu_used
Tagsstring

标签。

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

获取对应指标的英文。

elastic_executor_avg_cpu_use
AccessDeniedDetailstring

访问被拒绝详细信息;只有校验 RAM 失败后,字段才会返回。

{ "AuthAction": "xxx", "AuthPrincipalDisplayName": "sampleName", "AuthPrincipalOwnerId": "111111111111111111", "AuthPrincipalType": "SubUser", "AuthResource": "xxx", "NoPermissionType": "xxx", "PolicyType": "xxx" }

示例

正常返回示例

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*****\"",
          "TranslateKey": "elastic_executor_avg_cpu_use"
        }
      ]
    }
  ],
  "AccessDeniedDetail": "{\n  \"AuthAction\": \"xxx\",\n  \"AuthPrincipalDisplayName\": \"sampleName\",\n  \"AuthPrincipalOwnerId\": \"111111111111111111\",\n  \"AuthPrincipalType\": \"SubUser\",\n  \"AuthResource\": \"xxx\",\n  \"NoPermissionType\": \"xxx\",\n  \"PolicyType\": \"xxx\"\n}"
}

错误码

HTTP status code错误码错误信息
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.

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2024-11-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-10-10OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-04-06OpenAPI 错误码发生变更查看变更详情
  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等