调用DescribeDBProxy接口查询RDS实例的数据库独享代理详情。

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

调用该接口时，需要实例为如下版本：

  • MySQL 8.0三节点企业版（内核小版本20191204或以上）
  • MySQL 8.0高可用版（内核小版本20190915或以上）
  • MySQL 5.7三节点企业版（内核小版本20191128或以上）
  • MySQL 5.7高可用版（内核小版本20190925或以上）
  • MySQL 5.6高可用版（内核小版本20200229或以上）

调试

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

请求参数

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

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

DBInstanceId String 是 rm-uf6wjk5xxxxxxx

实例ID。
RegionId String 否 cn-hangzhou

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

返回数据

名称 类型 示例值 描述
DBProxyConnectStringItems Array of DBProxyConnectStringItems

独享代理的连接地址信息列表。
DBProxyConnectStringItems
DBProxyConnectString String ta9umxxxxx.rwlb.singapore.rds.aliyuncs.com

代理连接地址，也是读写分离的地址。
DBProxyConnectStringNetType String InnerString

代理连接地址的网络类型。取值：

  • InnerString：内网
  • OuterString：外网
DBProxyConnectStringNetWorkType String 1

代理网络类型，取值：

  • 0：外网
  • 1：内网（经典网络）
  • 2：内网（VPC网络）
DBProxyConnectStringPort String 3306

代理连接地址的端口。
DBProxyEndpointId String 330

代理连接地址ID。
DBProxyEndpointName String h7mnkxxxxx

代理终端名称。
DBProxyVpcInstanceId String rm-t4n4xxxxxxx

代理的实例ID。
DBProxyInstanceCurrentMinorVersion String 1.9.19

代理实例当前版本。
DBProxyInstanceLatestMinorVersion String 1.9.23

代理实例最新版本。
DBProxyInstanceName String h7mnkxxxxx

代理实例名称。
DBProxyInstanceNum Integer 2

开通的代理实例数量。
DBProxyInstanceStatus String Running

代理地址的运行状态，取值：

  • CREATING：创建中
  • ACTIVATION：运行中
  • DELETING：删除中
  • RESTARTING：重启中
  • CLASS_CHANGING：变配中
  • TRANSING：迁移中
  • MINOR_VERSION_UPGRADING：小版本升级中
DBProxyInstanceType String 2

代理服务类型。取值：

  • 1：共享代理服务
  • 2：独享代理服务
DBProxyServiceStatus String Startup

数据库独享代理功能开关状态。
RequestId String C6F00DF0-23F4-466F-BE43-DC9283A8D512

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDBProxy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeDBProxyResponse>
  <DBProxyInstanceName>h7mnkxxxxx</DBProxyInstanceName>
  <DBProxyInstanceCurrentMinorVersion>1.11.11</DBProxyInstanceCurrentMinorVersion>
  <DBProxyServiceStatus>Startup</DBProxyServiceStatus>
  <DBProxyInstanceNum>2</DBProxyInstanceNum>
  <DBProxyInstanceLatestMinorVersion>1.11.12</DBProxyInstanceLatestMinorVersion>
  <RequestId>CE986188-CFF3-4C19-982F-4B3A6F04FA58</RequestId>
  <DBProxyConnectStringItems>
        <DBProxyConnectStringItems>
              <DBProxyConnectString>xxxxx-rw4rm.rwlb.rds.aliyuncs.com</DBProxyConnectString>
              <DBProxyEndpointId>111111</DBProxyEndpointId>
              <DBProxyEndpointName>h7mnkxxxxx</DBProxyEndpointName>
              <DBProxyConnectStringNetWorkType>0</DBProxyConnectStringNetWorkType>
              <DBProxyConnectStringNetType>OuterString</DBProxyConnectStringNetType>
              <DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
        </DBProxyConnectStringItems>
  </DBProxyConnectStringItems>
  <DBProxyInstanceStatus>Running</DBProxyInstanceStatus>
  <DBProxyInstanceType>2</DBProxyInstanceType>
</DescribeDBProxyResponse>

JSON 格式 

{
	"DBProxyInstanceName": "h7mnkxxxxx",
	"DBProxyInstanceCurrentMinorVersion": "1.11.11",
	"DBProxyServiceStatus": "Startup",
	"DBProxyInstanceNum": 2,
	"DBProxyInstanceLatestMinorVersion": "1.11.12",
	"RequestId": "CE986188-CFF3-4C19-982F-4B3A6F04FA58",
	"DBProxyConnectStringItems": {
		"DBProxyConnectStringItems": [
			{
				"DBProxyConnectString": "xxxxx-rw4rm.rwlb.rds.aliyuncs.com",
				"DBProxyEndpointId": 111111,
				"DBProxyEndpointName": "h7mnkxxxxx",
				"DBProxyConnectStringNetWorkType": 0,
				"DBProxyConnectStringNetType": "OuterString",
				"DBProxyConnectStringPort": "3306"
			}
		]
	},
	"DBProxyInstanceStatus": "Running",
	"DBProxyInstanceType": "2"
}

错误码

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