DescribeDBClusterPerformance_云原生数据仓库AnalyticDB MySQL版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为500/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
adb:DescribeDBClusterPerformance
List
全部资源
*

请求参数

字段名称字段详情
DBClusterIdstring

AnalyticDB MySQL 版集群 ID。展开详情

示例值:am-8vbf80pjcz*****参考取值来源:
    ModifyDBCluster
    CreateDBCluster
    DescribeDBClusters
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参考取值来源:
    DescribeRegions
ResourcePoolsstring

资源组名称。

示例值:test参考取值来源:
    DescribeDBResourcePool

返回参数

字段名称字段详情
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>

集群性能指标列表。

AccessDeniedDetailstring

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

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

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断

变更历史

变更时间变更内容概要操作
2024-12-16
变更返回参数
2024-11-08
变更返回参数
2023-10-10
变更错误码400
删除错误码403
变更请求参数Key
变更请求参数StartTime
变更请求参数EndTime
新增请求参数RegionId
新增请求参数ResourcePools
变更返回参数
2023-04-06
新增错误码400
新增错误码403

相关示例

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