You can call the DescribeDBInstanceProxyConfiguration operation to query the settings of shared proxies that are enabled on an ApsaraDB RDS instance.

This operation is used to query the original settings of shared proxies rather than the latest settings of dedicated proxies. For more information about how to query the settings of dedicated proxies, see DescribeDBProxy.

Before you call this operation, make sure that the following requirements are met:

  • The shared proxy feature must be enabled for the primary instance.
  • The read/write splitting feature must be enabled for the primary instance.

Debugging

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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBInstanceProxyConfiguration

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

DBInstanceId String Yes rm-uf6wjk5xxxxxxxxxx

The ID of the instance.

Response parameters

Parameter Type Example Description
AttacksProtectionConfiguration String {\"check_interval_seconds\":\"0\",\"max_failed_login_attempts\":\"0\",\"blocking_seconds\":\"0\",\"status\":\"Disable\"}

Indicates whether the mechanism that is used to mitigate brute-force attacks is enabled:

  • Enable
  • Disable

The return value is a JSON string. Examples:

{"status":"Disable", "check_interval_seconds": 60,

"max_failed_login_attempts": 60, "blocking_seconds": 600}

Description:

  • Each client allows {max_failed_login_attempts} logon attempts that fail due to incorrect passwords within {check_interval_seconds} seconds. If one more such attempt is conducted, the client must wait for {blocking_seconds} seconds before you can try again.
  • Valid values:
    • check_interval_seconds: 30 to 600. Unit: seconds.
    • max_failed_login_attempts: 10 to 5000. Unit: times.
    • blocking_seconds: 30 to 3600. Unit: seconds.
PersistentConnectionsConfiguration String {\"status\":\"Disable\"}

Indicates whether the short-lived connection optimization feature is enabled.

  • Enable
  • Disable

The return value is a JSON string. Example:

{"status":"Disable"}.
TransparentSwitchConfiguration String {\"status\":\"Enable\"}

Indicates whether the transparent switchover feature is enabled.

  • Enable
  • Disable

The return value is a JSON string. Example:

{"status":"Enable"}.
RequestId String E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribeDBInstanceProxyConfigurationResponse>
	  <PersistentConnectionsConfiguration>{"status":"Disable"}</PersistentConnectionsConfiguration>
	  <TransparentSwitchConfiguration>{"status":"Enable"}</TransparentSwitchConfiguration>
	  <AttacksProtectionConfiguration>{"check_interval_seconds":"0","max_failed_login_attempts":"0","blocking_seconds":"0","status":"Disable"}</AttacksProtectionConfiguration>
	  <RequestId>E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34</RequestId>
</DescribeDBInstanceProxyConfigurationResponse>

JSON format 

{
    "PersistentConnectionsConfiguration": "{\"status\":\"Disable\"}", 
    "TransparentSwitchConfiguration": "{\"status\":\"Enable\"}", 
    "AttacksProtectionConfiguration": "{\"check_interval_seconds\":\"0\",\"max_failed_login_attempts\":\"0\",\"blocking_seconds\":\"0\",\"status\":\"Disable\"}", 
    "RequestId": "E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34"
}

Error codes

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