Queries the dedicated proxy of an ApsaraDB for RDS instance.

The Dedicated Proxy feature of ApsaraDB for RDS offers functions such as read/write splitting and short-lived connection optimization. For more information, see Dedicated proxy.

Before you call this operation, make sure that the instance runs one of the following MySQL versions and RDS editions:

  • MySQL 8.0 in the Enterprise Edition (with a kernel version of 20191204 or later)
  • MySQL 8.0 in the High-availability Edition (with a kernel version of 20190915 or later)
  • MySQL 5.7 in the Enterprise Edition (with a kernel version of 20191128 or later)
  • MySQL 5.7 in the High-availability Edition (with a kernel version of 20190925 or later)

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBProxy

The operation that you want to perform. Set the value to DescribeDBProxy.

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

RegionId String No cn-hangzhou

The ID of the region to which the instance belongs. You can call the DescribeRegions operation to query the most recent region list.

Response parameters

Parameter Type Example Description
RequestId String C6F00DF0-23F4-466F-BE43-DC9283A8D512

The ID of the request.

DBProxyServiceStatus String Startup

The status of the Dedicated Proxy feature on the instance.

DBProxyInstanceType String DedicatedProxy

The type of proxy used on the instance. Only the Dedicated Proxy feature is supported. Valid value: DedicatedProxy.

DBProxyInstanceNum Integer 2

The number of proxy instances created on the instance.

DBProxyInstanceStatus String Running

The status of the proxy endpoint.

DBProxyInstanceCurrentMinorVersion String 1.9.19

The current version of proxy instances.

DBProxyInstanceLatestMinorVersion String 1.9.23

The latest version available to proxy instances.

DBProxyConnectStringItems Array

An array consisting of information about the proxy endpoint.

DBProxyEndpointId String 330

The ID of the proxy endpoint.

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

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

DBProxyConnectStringPort String 3306

The port of the proxy endpoint.

DBProxyConnectStringNetType String InnerString

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

DBProxyVpcInstanceId String rm-t4n4xxxxxxx

The ID of the proxy instance.

DBProxyEndpointName String xxxxxx

The name of the proxy instance.

Examples

Sample requests

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

Sample success responses

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,
                "DBProxyConnectStringNetType": "InnerString",
                "DBProxyConnectString": "ta9umxxxxx.rwlb.singapore.rds.aliyuncs.com",
                "DBProxyConnectStringPort": "3306",
                "DBProxyVpcInstanceId":"rm-t4n4xxxxxx"
            }
        ]
    },
    "DBProxyInstanceNum": 2,
    "DBProxyInstanceType": "2",
    "DBProxyServiceStatus": "Startup"
}

Error codes

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