调用DescribeDBProxyPerformance接口查询数据库代理的性能数据。

已调用ModifyDBProxy接口开通数据库代理。

  • RDS MySQL提供数据库独享代理服务,包括读写分离、短连接优化等能力。详情请参见数据库独享代理
  • RDS PostgreSQL提供数据库代理服务,支持读写分离。详情请参见数据库代理

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBProxyPerformance

系统规定参数。取值:DescribeDBProxyPerformance

DBInstanceId String rm-t4n3axxxxx

RDS实例ID。可调用DescribeDBInstances接口查询。

DBProxyInstanceType String DedicatedProxy

代理服务类型。当前仅支持独享代理服务,取值:DedicatedProxy

StartTime String 2019-09-19T01:00:00Z

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

EndTime String 2019-09-21T18:00:00Z

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

RegionId String cn-hangzhou

地域ID,可以通过接口DescribeRegions查看地域ID。

MetricsName String Maxscale_CpuUsage

性能指标。

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

RDS PostgreSQL查询如下性能数据:

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

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

DBProxyEngineType String normal

内部参数,无需传入值。

返回数据

名称 类型 示例值 描述
EndTime String 2019-09-21T18:00:00Z

查询结束时间。

StartTime String 2019-09-19T01:00:00Z

查询开始时间。

DBInstanceId String lsmexxxxxxx

监控实例的ID。

RequestId String DD31056F-A0CE-41D7-AD39-689B6ABAE982

请求ID。

DBProxyEngineType String normal

内部参数,无需关注。

PerformanceKeys Array of PerformanceKey

性能列表。

PerformanceKey
ValueFormat String docker_container_cpu

性能值的格式。

Key String cpu_ratio

性能参数。

Values Array of PerformanceValue

数组格式:{value1, value2, …}。

PerformanceValue
Date String 2019-10-10T09:00:00Z

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

Value String 2.83

性能值。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDBProxyPerformance
&RegionId=cn-hangzhou
&DBInstanceId=rm-t4n3axxxxx
&MetricsName=Maxscale_CpuUsage
&StartTime=2019-09-19T01:00:00Z
&EndTime=2019-09-21T18:00:00Z
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBProxyPerformanceResponse>
<DBInstanceId>lsmexxxxxxx</DBInstanceId>
<RequestId>DD31056F-A0CE-41D7-AD39-689B6ABAE982</RequestId>
<PerformanceKeys>
    <PerformanceKey>
        <Values>
            <PerformanceValue>
                <Value>2.83</Value>
                <Date>2019-10-10T09:00:00Z</Date>
            </PerformanceValue>
        </Values>
        <Key>cpu_ratio</Key>
        <ValueFormat>docker_container_cpu</ValueFormat>
    </PerformanceKey>
</PerformanceKeys>
<EndTime>2019-10-10T09:39:28Z</EndTime>
<StartTime>2019-10-01T09:39:28Z</StartTime>
</DescribeDBProxyPerformanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DBInstanceId" : "lsmexxxxxxx",
  "RequestId" : "DD31056F-A0CE-41D7-AD39-689B6ABAE982",
  "PerformanceKeys" : {
    "PerformanceKey" : [ {
      "Values" : {
        "PerformanceValue" : [ {
          "Value" : "2.83",
          "Date" : "2019-10-10T09:00:00Z"
        } ]
      },
      "Key" : "cpu_ratio",
      "ValueFormat" : "docker_container_cpu"
    } ]
  },
  "EndTime" : "2019-10-10T09:39:28Z",
  "StartTime" : "2019-10-01T09:39:28Z"
}

错误码

HttpCode 错误码 错误信息 描述
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. 未找到指定独享代理连接地址的端口。

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