调用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:DescribeDBProxyPerformance	READ	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例ID。可调用DescribeDBInstances获取。	rm-t4n3a****
DBProxyInstanceType	string	否	代理服务类型。当前仅支持独享代理服务，取值：DedicatedProxy。	DedicatedProxy
StartTime	string	是	查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2019-09-19T01:00:00Z
EndTime	string	是	查询结束时间，不能早于查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2019-09-21T18:00:00Z
RegionId	string	是	地域ID。可调用DescribeRegions获取。	cn-hangzhou
MetricsName	string	是	性能指标。 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
DBProxyEngineType	string	否	预留参数，无需配置。	normal

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
EndTime	string	查询结束时间。	2019-09-21T18:00:00Z
StartTime	string	查询开始时间。	2019-09-19T01:00:00Z
DBInstanceId	string	监控实例的ID。	lsme****
RequestId	string	请求ID。	DD31056F-A0CE-41D7-AD39-689B6ABAE982
DBProxyEngineType	string	内部参数，无需关注。	normal
PerformanceKeys	object []	性能列表。
ValueFormat	string	性能值的格式。	docker_container_cpu
Key	string	性能参数。	cpu_ratio
Values	object []	性能值列表。
Date	string	记录日期。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2019-10-10T09:00:00Z
Value	string	性能值。	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	错误码	错误信息	描述
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.	数据库实例名称不存在，请检查。
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	指定的实例名称（DBInstanceName）无效，请检查参数值是否为null或空字符串。
404	Endpoint.NotFound	Specified endpoint is not found.	未找到指定独享代理连接地址的端口。

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

变更历史

变更时间

变更内容概要

操作

2022-06-23

OpenAPI 描述信息更新，OpenAPI 错误码发生变更

看变更集

变更项	变更内容
API 描述	OpenAPI 描述信息更新
错误码	OpenAPI 错误码发生变更
	删除错误码：400
	删除错误码：404

2022-06-08

OpenAPI 错误码发生变更，OpenAPI 入参发生变更，OpenAPI 返回结构发生变更