DescribeDBClusterPerformance - 查询PolarDB集群的性能数据

更新时间: 2023-11-07 12:13:10

查询PolarDB集群的性能数据。

接口说明

  • 若监控频率为5秒/次:

    • 当查询时间范围小于等于1小时,显示粒度为5秒。
    • 当查询时间范围小于等于1天,显示粒度为1分钟。
    • 当查询时间范围小于等于7天,显示粒度为10分钟。
    • 当查询时间范围小于等于30天,显示粒度为1小时。
    • 当查询范围大于30天,显示粒度为1天。
  • 若监控频率为60秒/次:

    • 当查询范围小于等于1天,显示粒度为1分钟。
    • 当查询范围小于等于7天,显示粒度为10分钟。
    • 当查询范围小于等于30天,显示粒度为1小时。
    • 当查询范围大于30天,显示粒度为1天。
说明 监控频率默认为60秒/次,您可以调用ModifyDBClusterMonitor接口将其设置为5秒/次。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribeDBClusterPerformanceRead
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

请求参数

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

集群ID。

pc-****************
Keystring

查询的性能指标,多个值间用英文逗号(,)分隔,详细参数请参见性能参数表

说明 最多可传入5个查询的性能指标。
PolarDBDiskUsage
StartTimestring

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

2020-09-23T01:01Z
EndTimestring

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

2020-09-23T01:00Z

返回参数

名称类型描述示例值
object
PerformanceKeysobject []

集群性能数据列表。

MetricNamestring

具体的性能指标度量名称。

mean_data_size
Measurementstring

性能指标。

PolarDBDiskUsage
Pointsobject []

性能数据数组。

Valuestring

监控指标数据值。

42.38
Timestamplong

监控指标的具体时间点,格式为时间戳,单位为毫秒。

1600822800000
DBNodeIdstring

数据库集群节点ID。

说明 当请求参数中Key的值设置为PolarDBDiskUsage时,不会返回该参数。
pi-*************
DBVersionstring

兼容数据库版本。

8.0
EndTimestring

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

2020-09-23T01:01:00Z
RequestIdstring

请求ID。

35D3E3DA-4650-407A-BFF5-59BFF1******
StartTimestring

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

2020-09-23T01:00:00Z
DBClusterIdstring

数据库集群ID。

pc-*****************
DBTypestring

兼容数据库类型。

MySQL

示例

正常返回示例

JSON格式

{
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "mean_data_size",
        "Measurement": "PolarDBDiskUsage",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "42.38",
              "Timestamp": 1600822800000
            }
          ]
        },
        "DBNodeId": "pi-*************"
      }
    ]
  },
  "DBVersion": "8.0",
  "EndTime": "2020-09-23T01:01:00Z",
  "RequestId": "35D3E3DA-4650-407A-BFF5-59BFF1******",
  "StartTime": "2020-09-23T01:00:00Z",
  "DBClusterId": "pc-*****************",
  "DBType": "MySQL"
}

错误码

HTTP status code错误码错误信息描述
400InvalidKey.MalformedThe specified parameter Key is not valid.指定的参数键无效
400InvalidEndTime.MalformedThe specified parameter EndTime is not valid.指定的参数EndTime无效
400InvalidStartTime.MalformedThe specified parameter StartTime is not valid.指定的参数StartTime无效
400InvalidParameterCombinationThe end time must be greater than the start time.结束时间必须大于开始时间
400InvalidDateRange.MalformedThe Date Range can not more than one month.日期范围不能超过一个月。
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的 DBClusterId。
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效

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

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 404 变更
阿里云首页 云原生数据库 PolarDB 相关技术圈