DescribeDBClusterPerformance - 查看集群性能数据 - 云原生数据仓库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	是	需要查询的性能指标名称，多个值之间用英文逗号（,）分隔。支持查询如下性能指标： CPU AnalyticDB_CPU_Usage_Percentage：CPU 平均使用率。连接数 AnalyticDB_Instance_Connection_Count：数据库连接数。写入 AnalyticDB_TPS：写入 TPS。 AnalyticDB_InsertRT：写入响应时间。 AnalyticDB_InsertBytes：写入吞吐量。查询 AnalyticDB_QPS：查询 QPS。 AnalyticDB_QueryRT：查询响应时间。 AnalyticDB_QueryWaitTime：查询等待耗时。磁盘 AnalyticDB_Disk_IO_Avg_Usage_Percentage：IO 平均 Util。 AnalyticDB_Disk_IO_Avg_Waiting_Time：IO 平均 Wait。 AnalyticDB_IO_Throughput：磁盘吞吐 AnalyticDB_IOPS：磁盘 IOPS。 AnalyticDB_Disk_Usage：磁盘使用量。 AnalyticDB_Disk_Usage_Percentage：磁盘使用率 AnalyticDB_Hot_Data_Usage：热数据磁盘用量。 AnalyticDB_Cold_Data_Usage：冷数据磁盘用量。说明该参数不能为空。	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	CPU AnalyticDB_CPU_Usage_Percentage：CPU 使用率。 AnalyticDB_Storage_CPU_Avg_Usage_Percentage：存储节点平均 CPU 使用率。 AnalyticDB_Storage_CPU_Max_Usage_Percentage：存储节点最大 CPU 使用率。 AnalyticDB_Compute_CPU_Avg_Usage_Percentage：计算节点平均 CPU 使用率。 AnalyticDB_Compute_CPU_Max_Usage_Percentage：计算节点最大 CPU 使用率。 AnalyticDB_CS_CPU_Avg_Usage_Percentage：接入节点平均 CPU 使用率。 AnalyticDB_CS_CPU_Max_Usage_Percentage：接入节点最大 CPU 使用率。连接数 AnalyticDB_Instance_Connection_Count：集群连接数。 AnalyticDB_Instance_Connection_Count：集群连接数。写入 AnalyticDB_TPS：写入 TPS。 tps：insert_tps、update_tps、 delete_tps 和 load_tps 的累加值。 insert_tps：INSERT INTO VALUES 操作每秒成功数。 update_tps：UPDATE 操作每秒成功数。 delete_tps：DELETE 操作每秒成功数。 load_tps：LOAD 操作（INSERT OVERWRITE）每秒成功数。 AnalyticDB_InsertRT：写入响应时间。 AnalyticDB_Avg_InsertRT：写入操作平均耗时。 AnalyticDB_Max_InsertRT：写入操作最大耗时。 AnalyticDB_InsertBytes：写入吞吐量。 AnalyticDB_InsertBytes：写入数据量。更新 AnalyticDB_UpdateRT：更新响应时间。 updateinto_avg_rt：UPDATE 操作平均耗时。 updateinto_max_rt：UPDATE 操作最大耗时。删除 AnalyticDB_DeleteRT：删除响应时间。 delete_avg_rt：DELETE 操作平均耗时。 delete_max_rt：DELETE 操作平均耗时。查询 AnalyticDB_QPS：QPS。 AnalyticDB_QPS：SELECT 操作每秒完成数。 AnalyticDB_ETL_QPS：ETL 操作（INSERT OVERWRITE）每秒完成数。 AnalyticDB_QueryRT：查询响应时间。 AnalyticDB_Avg_QueryRT：查询平均耗时。 AnalyticDB_Max_QueryRT：查询最大耗时。 etl_avg_rt：ETL 操作平均耗时。 etl_max_rt：ETL 操作最大耗时。 AnalyticDB_QueryWaitTime：查询等待耗时。 AnalyticDB_Avg_QueryWaitTime：查询（包括 SELECT 和 ETL）平均等待时间。 AnalyticDB_Max_QueryWaitTime：查询（包括 SELECT 和 ETL）最大等待时间。 AnalyticDB_QueryFailedRatio：查询失败率。 query_failed_ratio：查询（包括 SELECT 和 ETL）失败率。磁盘 AnalyticDB_IO_Throughput：磁盘 IO 吞吐。 AnalyticDB_Storage_Read_IO_Throughput：存储节点平均读操作吞吐。 AnalyticDB_Storage_Write_IO_Throughput：存储节点平均写操作吞吐。 AnalyticDB_Compute_Read_IO_Throughput：计算节点平均读操作吞吐。 AnalyticDB_Compute_Write_IO_Throughput：计算节点平均写操作吞吐。 AnalyticDB_Disk_IO_Avg_Usage_Percentage：IO 使用率。 AnalyticDB_Disk_IO_Avg_Usage_Percentage：存储节点 IO 使用率。 AnalyticDB_Disk_IO_Avg_Waiting_Time：IO 等待时间。 AnalyticDB_Disk_IO_Avg_Waiting_Time：存储节点平均 IO 等待时间。 AnalyticDB_IOPS：磁盘 IOPS。 AnalyticDB_Storage_Read_IOPS：存储节点平均读 IOPS。 AnalyticDB_Storage_Write_IOPS：存储节点平均写 IOPS。 AnalyticDB_Compute_Read_IOPS：计算节点读 IOPS。 AnalyticDB_Compute_Write_IOPS：计算节点写 IOPS。 AnalyticDB_DiskUsage -> AnalyticDB_DiskUsedSize：磁盘用量。 disk_used_ratio：磁盘空间使用率。 worker_max_node_disk_used_ratio：磁盘空间使用率最大节点的使用率。 AnalyticDB_Hot_Data_Usage：热数据磁盘用量。 AnalyticDB_Hot_Data_Usage：热数据磁盘使用量。 AnalyticDB_Cold_Data_Usage：冷数据磁盘用量。 AnalyticDB_Cold_Data_Usage：冷数据磁盘使用量。 AnalyticDB_DiskUsedRatio：节点磁盘使用率。 disk_used_ratio：平均节点磁盘使用率。 worker_max_node_disk_used_ratio：最大节点磁盘使用率。 AnalyticDB_DiskUsedSize：总数据量。 user_used_disk_max：最大节点热数据量。 user_used_disk_avg：最大节点热数据量。 hot_disk_used：热数据量。 cold_disk_used：冷数据量。其他 AnalyticDB_BuildTaskCount ：Build 任务数。 max_build_task_count：运行中的最大 Build 任务数。 avg_build_task_count：运行中的平均 Build 任务数。 AnalyticDB_ComputeMemoryUsedRatio: 计算内存使用率。 max_worker_compute_memory_used_ratio：存储节点最大计算内存使用率。 avg_worker_compute_memory_used_ratio：存储节点平均计算内存使用率。 max_executor_compute_memory_used_ratio：计算节点最大计算内存使用率。 avg_executor_compute_memory_used_ratio：计算节点平均计算内存使用率。 AnalyticDB_UnavailableNodeCount：不可用节点数。 worker_unavailable_node_count：存储节点不可用节点数。 executor_unavailable_node_count：计算节点不可用节点数。 WLM 相关 AnalyticDB_WLM_ResubmitQueries_Count：WLM 重新投递查询数。 AnalyticDB_WLM_ResubmitQueries_Count：WLM 重新投递查询数。 AnalyticDB_WLM_SQA_AvgRt_MS：WLM 小查询加速平均耗时。 AnalyticDB_WLM_SQA_AvgRt_MS：WLM 小查询加速平均耗时。 AnalyticDB_WLM_SQA_Queries_Count：WLM 小查询加速查询数。 AnalyticDB_WLM_SQA_Queries_Count：WLM 小查询加速查询数。 AnalyticDB_WLM_TotalQueries_Count：WLM 总查询数。 AnalyticDB_WLM_TotalQueries_Count：WLM 总查询数。 APS 相关 AnalyticDB_APS_BPS：湖仓版（3.0）APS BPS。 APS_Read_BPS：APS 读 BPS。 AnalyticDB_APS_CPU：湖仓版（3.0）APS CPU 利用率。 APS_CPU_Avg_Usage_Percentage：APS 平均 CPU 使用率。 APS_CPU_Max_Usage_Percentage：APS 最大 CPU 使用率。 AnalyticDB_APS_Memory：湖仓版（3.0）APS 内存利用率。 APS_Memory_Avg_Usage_Percentage：APS 平均内存使用率。 APS_Memory_Max_Usage_Percentage：APS 最大内存使用率。 AnalyticDB_APS_RPS：湖仓版（3.0）RPS RPS。 APS_Read_RPS：APS 读 RPS。 AnalyticDB_APS_RT：湖仓版（3.0）APS RT。 APS_Read_Avg_RT：APS 平均耗时。 APS_Read_Max_RT：APS 最大耗时。	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	错误码	错误信息
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 错误码发生变更	查看变更详情