All Products
Search

This Product

    ApsaraDB RDS:DescribeDBInstanceProxyConfiguration

    Document Center

    ApsaraDB RDS:DescribeDBInstanceProxyConfiguration

    Last Updated:Apr 26, 2023

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

    Operation Description

    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.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociation operation
    rds:DescribeDBInstanceProxyConfigurationREAD
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance.

    		rm-uf6wjk5xxxxxxxxxx

    Response parameters

    ParameterTypeDescriptionExample
    object
    PersistentConnectionsConfigurationstring

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

    • Enable
    • Disable

    The return value is a JSON string. Example:

    {"status":"Disable"}.

    		{\"status\":\"Disable\"}
    AttacksProtectionConfigurationstring

    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.
    		{\"check_interval_seconds\":\"0\",\"max_failed_login_attempts\":\"0\",\"blocking_seconds\":\"0\",\"status\":\"Disable\"}
    RequestIdstring

    The ID of the request.

    		E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34
    TransparentSwitchConfigurationstring

    Indicates whether the transparent switchover feature is enabled.

    • Enable
    • Disable

    The return value is a JSON string. Example:

    {"status":"Enable"}.

    		{\"status\":\"Enable\"}

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.