使用DescribeDBClusterPerformance查询集群性能数据-云原生数据仓库AnalyticDB-阿里云-云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

adb:DescribeDBClusterPerformance

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	AnalyticDB MySQL 版集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 版集群的详情，包括集群 ID。	am-8vbf80pjcz*****
Key	string	否	需要查询的性能指标名称（监控项 Key），多个值之间用英文逗号（,）分隔。支持查询的指标详情请参见监控项概览。	AnalyticDB_CPU
StartTime	string	否	查询开始时间。格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2021-05-03T15:00Z
EndTime	string	否	查询结束时间。格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。说明查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过两天。	2021-05-03T15:01Z
RegionId	string	是	集群所在的地域。	cn-hangzhou
ResourcePools	string	否	资源组名称。	test

返回参数

名称	类型	描述	示例值
	object	列表详情。
EndTime	string	查询结束时间。格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2021-05-03T15:01:00Z
RequestId	string	请求 ID。	25B56BC7-4978-40B3-9E48-4B7067******
StartTime	string	查询开始时间。格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2021-05-03T15:00:00Z
DBClusterId	string	集群 ID。	am-8vbf80pjcz*****
Performances	array<object>	集群性能指标列表。
	array<object>	列表。
Key	string	性能指标名称。	AnalyticDB_CPU
Unit	string	数据单位。	%
Series	array<object>	性能数据列表。
	object	列表。
Values	array	性能指标数值详情。
	string	不同时间点下的性能值详情。	[ "2021-05-03T15:00:12.72Z", "0.1250" ], [ "2021-05-03T15:00:42.739Z", "0.3125" ]
Name	string	性能指标名称（监控指标 Value Name）。指标详情请参见监控项概览。	worker_avg_cpu_used
Tags	string	标签。	instance_name: "amv-8vbf80pjcz*****"
TranslateKey	string	获取对应指标的英文。	elastic_executor_avg_cpu_use
AccessDeniedDetail	string	访问被拒绝详细信息；只有校验 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	错误码	错误信息	描述
400	IdempotentParameterMismatch	The 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.

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

变更历史

更多信息，参考变更详情。