All Products
Search

This Product

    ApsaraDB RDS:ModifyDBInstanceProxyConfiguration

    Document Center

    ApsaraDB RDS:ModifyDBInstanceProxyConfiguration

    Last Updated:May 29, 2023

    You can call the ModifyDBInstanceProxyConfiguration operation to configure the database proxy for an instance.

    Operation Description

    NoteThis operation is phased out.

    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 keyAssociated operation
    rds:ModifyDBInstanceProxyConfigurationWRITE
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance.

    		rm-uf6wjk5xxxxxxxxxx
    ProxyConfigurationKeystringYes

    The key of the configuration item for the database proxy. Valid values:

    • TransparentSwitch: transparent switchover
    • PersistentConnections: short-lived connection optimization
    • AttacksProtection: brute-force attack protection
    		TransparentSwitch
    ProxyConfigurationValuestringYes

    The value of the configuration item for the database proxy. Valid values:

    • If you set the ProxyConfigurationKey parameter to TransparentSwitch, you can set this parameter to one of the following values:

      • Enable. This is the default value.
      • Disable. Example: {"status":"Enable"}.

    • If you set the ProxyConfigurationKey parameter to PersistentConnections, you can set this parameter to one of the following values:

      • Enable.
      • Disable. This is the default value. Example: {"status":"Disable"}.

    • If you set the ProxyConfigurationKey parameter to AttacksProtection, you can set this parameter to one of the following values:

      • Enable.
      • Disable. This is the default value. Example: {"status":"Disable"}.

    In this case, the return value is a JSON string. Example:

    {"status":"Disable", "check_interval_seconds": 60,
                "max_failed_login_attempts": 60, "blocking_seconds": 600}

    Description and valid values:

    • Each client allows {max_failed_login_attempts} logon attempts upon failure within {check_interval_seconds} seconds. If the number of logon attempts exceeds the limit, the client is disabled for {blocking_seconds} seconds before the client can try again.
    • The following list describes the valid values of each field in the preceding example.

    check_interval_seconds: 30 to 600. Unit: seconds. max_failed_login_attempts: 10 to 5000. Unit: number of times. blocking_seconds: 30 to 3600. Unit: seconds.

    		{"status":"Enable"}

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		9705B5D2-C5B6-4526-B779-26D755EC1B8C

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "9705B5D2-C5B6-4526-B779-26D755EC1B8C"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ConnectionModeNotSupportedConnectionMode specified cannot be replicate with the source DB Instance.The operation failed. The connection mode that is specified by the ConnectionMode parameter cannot be replicated with the original RDS instance.
    400InvalidConfigurationValue.MalformedSpecified ConfigurationValue is not valid.The operation failed. The values of some parameters are invalid.
    400InvalidConfigurationValueStatus.MalformedSpecified ProxyConfigurationValue (status) is not valid.-
    400ProxyConnectionPersistExistsSpecified same ProxyConnectionPersist already exists.-
    400ProxyFailoverExistsSpecified same ProxyFailoverExists already exists.-
    403InvalidConfigurationValueOrther.MalformedSpecified ProxyConfigurationValue (check_interval_seconds or max_failed_login_attempts or blocking_seconds ) is not valid.The value of the ProxyConfigurationValue parameter is invalid. Check the value of this parameter before you proceed.
    403ProxyConnectionPersist.NotFoundSpecified ProxyConnectionPersist is not found.-
    403ProxyConnectionPersistParametersInvalidProxyConnectionPersist parameter out of range.-
    403InvalidConfigValueProxyConnectionPersist parameter config table not exits or data error.-
    403InvalidDBInstance.NotFoundSpecified instance does not exist or not support.The RDS instance cannot be found, is deleted, or does not support the operation.
    403ProxyFailover.NotFoundSpecified ProxyFailover is not found.-
    404EngineVersionNotSupportedEngineVersion specified cannot be replicate with the source DB Instance.Instance cloning is not supported for the database engine version of the current instance.
    404EngineNotSupportedEngine specified cannot be supported the operation.The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.

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