文档

DescribeDBProxyPerformance - 查询PolarDB代理层(PolarProxy)的性能数据

更新时间:

查询PolarDB代理层(PolarProxy)的性能数据。

接口说明

说明 该接口仅适用于 PolarDB MySQL 版。

调试

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

授权信息

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

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

请求参数

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

集群 ID。

pc-****************
DBEndpointIdstring

数据库代理连接地址 ID。支持集群地址与自定义地址的查询,不支持主地址的查询。不传则默认查询集群地址。

pe-****************
Intervalstring

性能数据粒度。取值范围如下:

  • 5
  • 30
  • 60
  • 600
  • 1800
  • 3600
  • 86400
60
Typestring

特殊指标,目前仅支持 tair(PolarTair 架构)。

tair
Keystring

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

PolarProxy_CpuUsage
StartTimestring

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

2020-09-23T01:01Z
EndTimestring

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

2020-09-24T02:08Z

返回参数

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

集群性能数据列表。

MetricNamestring

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

service_connections_ps
Measurementstring

性能指标。

PolarProxy_CpuUsage
Pointsobject []

性能数据数组。

Valuestring

监控指标数据值。

10
Timestamplong

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

1600822800000
DBNodeIdstring

数据库集群节点 ID。

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": "service_connections_ps",
        "Measurement": "PolarProxy_CpuUsage",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "10",
              "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错误码错误信息描述
400InvalidParameterCombinationThe end time must be greater than the start time.结束时间必须大于开始时间
400InvalidStartTime.MalformedThe specified parameter StartTime is not valid.指定的参数StartTime无效
400InvalidEndTime.MalformedThe specified parameter EndTime is not valid.指定的参数EndTime无效
400InvalidKey.MalformedThe specified parameter Key is not valid.指定的参数键无效
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的 DBClusterId。
404InvalidDBEndpointId.NotFoundThe DBEndpointId provided does not exist in our records.当前的记录中不存在提供的DBEndpointId。

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

变更历史

变更时间变更内容概要操作
2024-03-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:Type
2024-03-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:Interval
2024-02-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:DBEndpointId