Queries details about the dedicated database proxy for an RDS instance.

RDS provides the dedicated database proxy service, including read/write splitting and short-lived connection optimization. For more information, see Dedicated database proxy.

Make sure that the DB engine version and edition are MySQL 8.0 High-availability Edition (with local SSDs).

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

ID Type Required Example value Description
Action String Yes DescribeDBProxy The name of this API action. Valid value: DescribeDBProxy.
DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the specified RDS instance.

RegionId String No cn-hangzhou The ID of the region to which the RDS instance belongs. You can call the DescribeRegions API action to query this region ID.
AccessKeyId String No LTAIfCxxxxxxx

The AccessKey ID that Alibaba Cloud issues to a user for service access.

Response elements

ID Type Example value Description
DBProxyConnectStringItems N/A None

The list of endpoints available to the dedicated database proxy.

DBProxyConnectStringItems N/A None

The list of endpoints available to the dedicated database proxy.

DBProxyConnectString String ta9umxxxxx.rwlb.singapore.rds.aliyuncs.com

The proxy endpoint, which is also the endpoint for read/write splitting.

DBProxyConnectStringNetType String InnerString The network type of the proxy endpoint. Only an internal endpoint is supported. Valid value: InnerString.
DBProxyConnectStringPort String 3306

The port used by the proxy endpoint.

DBProxyEndpointId String 330

The ID of the proxy endpoint.

DBProxyVpcInstanceId String rm-t4n4xxxxxxx

The ID of a proxy instance.

DBProxyInstanceNum Integer 2

The number of proxy instances that are associated with the proxy endpoint.

DBProxyInstanceStatus String Running

The status of the proxy endpoint.

DBProxyInstanceType String DedicatedProxy The proxy service type. Only the dedicated database proxy service is supported. Valid value: DedicatedProxy.
DBProxyServiceStatus String Startup

The status of the dedicated database proxy service.

RequestId String C6F00DF0-23F4-466F-BE43-DC9283A8D512

The ID of the request.

Examples

Request example:


http(s)://rds.aliyuncs.com/? Action=DescribeDBProxy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Public request parameter>

Response example:

XML format:

<DescribeDBProxyResponse>
  <DBProxyInstanceStatus>Running</DBProxyInstanceStatus>
	  <RequestId>C6F00DF0-23F4-466F-BE43-DC9283A8D512</RequestId>
	  <DBProxyConnectStringItems>
		    <DBProxyConnectStringItems>
			      <DBProxyEndpointId>330</DBProxyEndpointId>
			      <DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
			      <DBProxyConnectString>ta9umxxxxx.rwlb.singapore.rds.aliyuncs.com</DBProxyConnectString>
			      <DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
                  <DBProxyVpcInstanceId>rm-t4n4xxxxxx</DBProxyVpcInstanceId>
		    </DBProxyConnectStringItems>
	  </DBProxyConnectStringItems>
	  <DBProxyInstanceNum>2</DBProxyInstanceNum>
	  <DBProxyInstanceType>2</DBProxyInstanceType>
	  <DBProxyServiceStatus>Startup</DBProxyServiceStatus>
</DescribeDBProxyResponse>

JSON format:

{
	"DBProxyInstanceStatus":"Running",
	"RequestId":"C6F00DF0-23F4-466F-BE43-DC9283A8D512",
	"DBProxyConnectStringItems":{
		"DBProxyConnectStringItems":[
			{
				"DBProxyEndpointId":330,
				"DBProxyConnectString":"ta9umxxxxx.rwlb.singapore.rds.aliyuncs.com",
				"DBProxyConnectStringNetType":"InnerString",
				"DBProxyVpcInstanceId":"rm-t4n4xxxxxx",
				"DBProxyConnectStringPort":"3306"
			}
		]
	},
	"DBProxyInstanceNum":2,
	"DBProxyInstanceType":"2",
	"DBProxyServiceStatus":"Startup"
}

Errors

For a list of error codes, visit the API Error Center.