调用DescribeDBProxyPerformance接口查询独享代理实例的性能数据。

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

调用该接口时，实例必须满足以下条件：

  • 实例已开通数据库独享代理功能。
  • 实例版本如下：
    • MySQL 8.0三节点企业版（内核小版本20191204或以上）
    • MySQL 8.0高可用版（内核小版本20190915或以上）
    • MySQL 5.7三节点企业版（内核小版本20191128或以上）
    • MySQL 5.7高可用版（内核小版本20190925或以上）

调试

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

请求参数

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

系统规定参数，取值：DescribeDBProxyPerformance。

DBInstanceId String 是 rm-t4n3axxxxx

实例ID。
EndTime String 是 2019-09-21T18:00:00Z

查询结束时间，不能早于查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

MetricsName String 是 Maxscale_CpuUsage

性能指标，根据DBProxyInstanceType决定有哪些性能指标可以查询。

当DBProxyInstanceType=DedicatedProxy，仅支持Maxscale_CpuUsage：CPU利用率。

RegionId String 是 cn-hangzhou

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

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

查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

DBProxyInstanceType String 否 DedicatedProxy

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

返回数据

名称 类型 示例值 描述
RequestId String DD31056F-A0CE-41D7-AD39-689B6ABAE982

请求ID。
DBInstanceId String lsmexxxxxxx

监控实例的ID。
StartTime String 2019-09-19T01:00:00Z

查询开始时间。
EndTime String 2019-09-21T18:00:00Z

查询结束时间。
PerformanceKeys Array

性能列表。
Key String cpu_ratio

性能参数。
ValueFormat String docker_container_cpu

性能值的格式。
Values Array

数组格式：{value1, value2, …}。
Value String 2.83

性能值。
Date String 2019-10-10T09:00:00Z

记录日期。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

示例

请求示例

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 格式 

<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 格式 

{
	"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"
}

错误码

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