文档

DescribeDBClusterPerformance - 查看性能数据

更新时间:

调用DescribeDBClusterPerformance接口查看云数据库ClickHouse社区兼容版集群的性能数据。

接口说明

根据性能参数查看指定集群在某时间段范围内的性能监控数据。采集粒度为 30 秒。

说明 该接口仅支持 2021 年 12 月 01 日之前创建的云数据库 ClickHouse 社区兼容版集群。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

集群 ID。

cc-bp125e3uu94wo****
Keystring

需要查询的性能指标名称,多个值之间用英文逗号(,)分隔。每次最多支持查询 5 个性能指标。支持查询如下性能指标:

说明 Key 为必填项。
  • CPU
    • CPU_USAGE:CPU 使用率。
  • 内存
    • MEM_USAGE:内存使用率。
    • MEM_USAGE_SIZE:内存使用量(单位:MB)。
  • 磁盘
    • DISK_USAGE:磁盘使用率。
    • DISK_USAGE_SIZE:磁盘使用量(单位:MB)。
    • IOPS:磁盘 IOPS。
  • 连接
    • CONN_USAGE:数据库连接使用率。
    • CONN_USAGE_COUNT:数据库使用连接数。
  • 写入
    • TPS:每秒写入行数。
    • INSERT_SIZE:每秒写入大小(单位:MB)。
  • 查询
    • QPS:查询 QPS。
    • AVG_SEEK:随机 SEEK 调用次数。
  • WAIT
    • ZK_WAIT:ZK 的平均等待时长(单位:ms)。
    • IO_WAIT:IO_WAIT 的平均等待时长(单位:ms)。
    • CPU_WAIT:CPU_WAIT 的平均等待时长(单位:ms)。
MEM_USAGE
StartTimestring

查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

2021-11-27T16:37Z
EndTimestring

查询结束时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

说明 查询结束时间需晚于开始时间,且开始时间和结束时间的时间间隔不能超过 32 天。
2021-11-27T16:38Z

返回参数

名称类型描述示例值
object
EndTimestring

查询结束时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

2021-11-27T16:38Z
RequestIdstring

请求 ID。

FE242962-6DA3-5FC8-9691-37B62A3210F7
StartTimestring

查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

2021-11-27T16:37Z
DBClusterIdstring

集群 ID。

cc-bp125e3uu94wo****
Performancesobject []

集群性能参数值列表。

Keystring

性能指标名称。

MEM_USAGE
Unitstring

数据单位。

%
Seriesobject []

性能参数集合。

Valuesobject []

性能参数值,每个值对应一个采集时间点。

Pointarray

性能值

string

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

[ "2021-11-26T16:39:00Z","15.08" ]
Namestring

性能数据列表的名称。

cc-bp125e3uu94wo1s0k16****
Namestring

性能值名称。

mem_usage

示例

正常返回示例

JSON格式

{
  "EndTime": "2021-11-27T16:38Z",
  "RequestId": "FE242962-6DA3-5FC8-9691-37B62A3210F7",
  "StartTime": "2021-11-27T16:37Z",
  "DBClusterId": "cc-bp125e3uu94wo****",
  "Performances": [
    {
      "Key": "MEM_USAGE",
      "Unit": "%",
      "Series": [
        {
          "Values": [
            {
              "Point": [
                "[ \"2021-11-26T16:39:00Z\",\"15.08\" ]"
              ]
            }
          ],
          "Name": "cc-bp125e3uu94wo1s0k16****"
        }
      ],
      "Name": "mem_usage"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈