All Products
Search

This Product

    ApsaraDB RDS:ModifyDBProxyInstance

    Document Center

    ApsaraDB RDS:ModifyDBProxyInstance

    Last Updated:Mar 21, 2023

    You can call the ModifyDBProxyInstance operation to modify the database proxy settings of an ApsaraDB RDS instance.

    Operation Description

    Before you call the ModifyDBProxyInstance operation, make sure that the ModifyDBProxy operation is called to enable the database proxy feature for the instance.

    • The dedicated proxy feature of ApsaraDB RDS for MySQL provides capabilities such as read/write splitting and short-lived connection optimization. For more information, see What are database proxies?
    • The database proxy feature of ApsaraDB RDS for PostgreSQL supports read/write splitting. For more information, see What are database proxies?

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

    		rm-t4n3a****
    DBProxyInstanceTypestringYes

    The type of database proxy that is enabled for the instance. Set the value to DedicatedProxy.

    		DedicatedProxy
    DBProxyInstanceNumstringYes

    The number of proxy instances that are enabled. If the value of this parameter is 0, the database proxy feature is disabled for the instance. Valid values: 1 to 60.

    NoteThe capability of the database proxy to process requests increases with the number of proxy instances that are enabled. You can monitor the load on the instance and specify an appropriate number of proxy instances based on the load monitoring data.
    		2
    EffectiveTimestringNo

    The time when you want to apply the new database proxy settings. Valid values:

    • Immediate: ApsaraDB RDS immediately applies the new settings.
    • MaintainTime: ApsaraDB RDS applies the new settings during the maintenance window that you specified. For more information, see Modify the maintenance window.
    • SpecificTime: ApsaraDB RDS applies the new settings at a specified point in time.

    Default value: MaintainTime.

    		MaintainTime
    EffectiveSpecificTimestringNo

    The point in time at which you want to apply the new database proxy settings. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

    NoteIf you set the EffectiveTime parameter to SpecificTime, you must specify the EffectiveSpecificTime parameter.
    		2019-07-10T13:15:12Z
    RegionIdstringNo

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

    		cn-hangzhou
    DBProxyEngineTypestringNo

    An internal parameter. You do not need to specify this parameter.

    		normal

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		65C55572-530E-4A53-BE03-1D08CAF0F046

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "65C55572-530E-4A53-BE03-1D08CAF0F046"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.
    403DBInstanceStatusNotActiveCurrent DB instance status should be active.The operation failed. Check the status of the RDS instance.
    403InvalidInstanceLevel.MalformedThe specified class code does not support the endpoint number. Please check the shard number and the current endpoint number.The operation failed. The number of proxy terminals that you configure is not supported for the instance type. Check the number of data shards and the number of proxy terminals.

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

    Change history

    Change timeSummary of changesOperation
    2022-06-23API Description Update,The error codes of the API operation change.
    Change itemChange content
    API DescriptionAPI Description Update
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
    2022-06-07The error codes of the API operation change.,The input parameters of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: DBProxyEngineType