文档

DescribeDBProxyPerformance - 查询数据库代理的性能数据

更新时间:

该接口用于查询RDS实例数据库代理的性能数据。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
说明 云数据库 RDS MySQL 集群系列于 2023 年 10 月 17 日起逐步在各个单元赠送代理数量为 1 的数据库独享代理服务,详情请参见【优惠】RDS MySQL 集群版赠送代理数量为 1 的数据库独享代理服务

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

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

授权信息

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

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

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-t4n3a****
DBProxyInstanceTypestring

数据库代理实例类型,取值:

  • common:通用型代理
  • exclusive:独享型代理
exclusive
StartTimestring

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

2019-09-19T01:00:00Z
EndTimestring

查询结束时间,不能早于查询开始时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-09-21T18:00:00Z
RegionIdstring

地域 ID。可调用 DescribeRegions 获取。

cn-hangzhou
MetricsNamestring

性能指标。

RDS MySQL 仅支持Maxscale_CpuUsage:CPU 使用率。

RDS PostgreSQL 查询如下性能数据:

  • Maxscale_TotalConns:连接速率
  • Maxscale_CurrentConns:当前连接数
  • Maxscale_DownFlows:出流量
  • Maxscale_UpFlows:入流量
  • Maxscale_QPS:请求速率(QPS)
  • Maxscale_MemUsage:内存使用率
  • Maxscale_CpuUsage:CPU 使用率

当查询多个性能数据时,可使用英文逗号(,)分隔,最多同时查询 6 个性能数据。

Maxscale_CpuUsage
DBProxyEngineTypestring

预留参数,无需配置。

normal

返回参数

名称类型描述示例值
object

返回参数详情。

EndTimestring

查询结束时间。

2019-09-21T18:00:00Z
StartTimestring

查询开始时间。

2019-09-19T01:00:00Z
DBInstanceIdstring

监控实例的 ID。

lsme****
RequestIdstring

请求 ID。

DD31056F-A0CE-41D7-AD39-689B6ABAE982
DBProxyEngineTypestring

内部参数,无需关注。

normal
PerformanceKeysobject []

性能列表。

ValueFormatstring

性能值的格式。

docker_container_cpu
Keystring

性能参数。

cpu_ratio
Valuesobject []

性能值列表。

Datestring

记录日期。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-10-10T09:00:00Z
Valuestring

性能值。

2.83

示例

正常返回示例

JSON格式

{
  "EndTime": "2019-09-21T18:00:00Z",
  "StartTime": "2019-09-19T01:00:00Z",
  "DBInstanceId": "lsme****",
  "RequestId": "DD31056F-A0CE-41D7-AD39-689B6ABAE982",
  "DBProxyEngineType": "normal",
  "PerformanceKeys": {
    "PerformanceKey": [
      {
        "ValueFormat": "docker_container_cpu",
        "Key": "cpu_ratio",
        "Values": {
          "PerformanceValue": [
            {
              "Date": "2019-10-10T09:00:00Z",
              "Value": "2.83"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
403ParamNotFoundThe parameter is not found for the interface.找不到接口的参数
404Endpoint.NotFoundSpecified endpoint is not found.未找到指定独享代理连接地址的端口。
404InvalidDBInstanceName.NotFoundThe DBInstanceId provided does not exist in our records.数据库实例ID不存在,请检查。

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

变更历史

变更时间变更内容概要操作
2024-01-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 404 变更
    删除错误码:403
2024-01-16OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
    删除错误码:403
2023-12-19OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    新增错误码:403
2022-06-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
2022-06-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:DBProxyEngineType
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈