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

查看目标集群的性能数据。

接口说明

当前服务的接入地址请参见服务接入点。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeDBClusterPerformance	list	*DBClusterLakeVersion `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值

名称	类型	必填	描述	示例值
DBClusterId	string	是	企业版、基础版或湖仓版的集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有集群 ID。	amv-bp1hx5n1o8f61****
Key	string	是	需要查询的性能指标名称（监控项 Key），多个值之间用英文逗号（,）分隔。支持查询的指标详情请参见监控项概览。	AnalyticDB_CPU_Usage_Percentage
StartTime	string	是	查询开始时间。UTC 时间，格式为yyyy-MM-ddTHH:mmZ。	2022-03-10T23:56Z
EndTime	string	是	查询结束时间。UTC 时间，格式为yyyy-MM-ddTHH:mmZ。说明查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过两天。	2022-03-11T15:01Z
RegionId	string	是	地域 ID。说明您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息，包括地域 ID。	cn-hangzhou
ResourcePools	string	否	资源组。	user_default

返回参数

名称	类型	描述	示例值

名称	类型	描述	示例值
	object
EndTime	string	查询结束时间。UTC 时间，格式为yyyy-MM-ddTHH:mmZ。	2022-03-11T15:01Z
RequestId	string	请求 ID。	BD8C3096-8BC6-51DF-A4AB-BACD9DC10435
StartTime	string	查询开始时间。UTC 时间，格式为yyyy-MM-ddTHH:mmZ。	2022-03-10T23:56Z
DBClusterId	string	集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有集群的集群 ID。	amv-bp1hx5n1o8f61****
Performances	array<object>	集群性能指标列表。
PerformanceItem	object	列表。
Key	string	性能指标名称。	AnalyticDB_CPU_Usage_Percentage
Unit	string	监控指标的单位。	%
Series	array<object>	性能数据列表。
SeriesItem	object	列表。
Values	array	不同时间点下的性能值详情。
Values	string	不同时间点下的性能值详情。	[ [ "2023-06-27T13:21:00+08:00","0.1250" ], [ "2022-03-11T10:00:42.739Z","0.3125" ]... ]
Name	string	性能指标名称（监控指标 Value Name）。详情请参见监控项概览。	AnalyticDB_Storage_CPU_Avg_Usage_Percentage
Tags	string	标签值。	{instance_name: "am-***"}

示例

正常返回示例

JSON格式

        

          
      
        
{
  "EndTime": "2022-03-11T15:01Z",
  "RequestId": "BD8C3096-8BC6-51DF-A4AB-BACD9DC10435",
  "StartTime": "2022-03-10T23:56Z",
  "DBClusterId": "amv-bp1hx5n1o8f61****",
  "Performances": [
    {
      "Key": "AnalyticDB_CPU_Usage_Percentage",
      "Unit": "%",
      "Series": [
        {
          "Values": [
            "[\n  [ \n  \"2023-06-27T13:21:00+08:00\",\"0.1250\" \n  ], \n  [ \n  \"2022-03-11T10:00:42.739Z\",\"0.3125\" \n  ]...\n]"
          ],
          "Name": "AnalyticDB_Storage_CPU_Avg_Usage_Percentage",
          "Tags": "\n{instance_name: \"am-***\"}",
          "TranslateKey": ""
        }
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息

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.

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

变更历史

变更时间	变更内容概要	操作

变更时间	变更内容概要	操作
2023-09-13	OpenAPI 错误码发生变更	查看变更详情