All Products
Search
Document Center

ApsaraDB RDS:ModifyDBProxy

Last Updated:Apr 17, 2024

Enables or disables the dedicated proxy feature for an instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
Note Starting October 17, 2023, ApsaraDB RDS provides a dedicated proxy free of charge for each ApsaraDB RDS for MySQL instance on RDS Cluster Edition. For more information, see [Special offers/Price changes] One proxy is provided free of charge for ApsaraDB RDS for MySQL instances on RDS Cluster Edition.

References

Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

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

rm-uf6wjk5xxxxxxx
ConfigDBProxyServicestringYes

Specifies whether to enable or disable the database proxy feature. Valid values:

  • Startup: enables the database proxy feature.
  • Shutdown: disables the database proxy feature.
Startup
DBProxyInstanceNumstringNo

The number of proxy instances that are enabled. Valid values: 1 to 16. Default value: 1.

Note The 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.
1
RegionIdstringNo

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
InstanceNetworkTypestringNo

The network type of the instance. Set the value to VPC.

Note This parameter is required if you enable the database proxy feature for an ApsaraDB RDS for MySQL instance that uses cloud disks or an ApsaraDB RDS for PostgreSQL instance.
VPC
VPCIdstringNo

The ID of the virtual private cloud (VPC) to which the instance belongs. You can call the DescribeDBInstanceAttribute operation to query the VPC ID.

Note This parameter is required if you enable the database proxy feature for an ApsaraDB RDS for MySQL instance that uses cloud disks or an ApsaraDB RDS for PostgreSQL instance.
vpc-xxxxxxxxxxxx
VSwitchIdstringNo

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

Note This parameter is required if you enable the database proxy feature for an ApsaraDB RDS for MySQL instance that uses cloud disks or an ApsaraDB RDS for PostgreSQL instance.
vsw-xxxxxxxxxxxx
DBProxyEngineTypestringNo

A reserved parameter. You do not need to specify this parameter.

normal
DBProxyInstanceTypestringNo

This parameter is reserved. You do not need to specify this parameter.

common
ResourceGroupIdstringNo

The resource group ID.

rg-acfmy*****
PersistentConnectionStatusstringNo

Whether to enable connection keep. Valid values:

  • Enabled: enables connection keeping
  • Disabled: disables connection hold
Note
  • This parameter is supported only for an ApsaraDB RDS for MySQL.
  • When you modify the connection persistence state, the value of ConfigDBProxyService is modify.
  • Enabled

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    FC452BB1-EED8-4278-95C7-0324B3710DF1

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "FC452BB1-EED8-4278-95C7-0324B3710DF1"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400MaxscaleAlreadyExistThe Maxscale is already existed.The specified Maxscale already exists.
    400MaxscaleNotSupportMaxscale not supportedDedicated proxy is not supported by the instance. Please check the configuration information about enabling dedicated proxy.
    400NetWork.NotFoundNetWork.NotFoundThe network is unavailable.
    400InvalidVpcParameterEither VPC ID or vSwitch ID is incorrect. Please check again.The operation failed. Check the value of the VPCId parameter.
    400MaxscaleInternalErrorDatabase proxy status is CLASS_CHANGING.The specifications of the database proxy are being changed. Restart the RDS instance later.
    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.
    400InvalidOptimizationCategory.FormatSpecified optimization category is not valid.The specified OptimizationCategory parameter is invalid.
    400MinorVersionNotSupportThe current database minor version does not support the operation.The operation is not supported for the minor engine version of the instance.
    400InvalidParameters.FormatSpecified parameter is not validThe operation failed. The values of some parameters are invalid.
    400MaxscaleNotSupportCurrent custins can not support Maxscale.This operation is not supported for instances with maxscale.
    400InvalidTunnelIdSpecified conn tunnel is not valid.-
    400InvalidRegion.FormatSpecified Region is not valid.The region ID is invalid. Check the region ID.
    403InvalidConnVPCIdSpecified conn vpc id is not valid.The specified VPC ID is invalid.
    403IncorrectDBInstanceTypeThe database instance type does not support the operation.The operation failed. The operation is not supported for the database engine of the RDS instance.
    403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
    403IncorrectKindCodeCurrent custins kindCode does not support this operation.The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    403InvalidVswitchIdSpecified conn vswitch id is not valid.-
    404MaxscaleCreatingThe relative maxscale instance is being created or deleted.-
    404Maxscale.NotFoundThe relative maxscale instance is not found.No associated maxscale instance is found.
    404InvalidVSwitchId.NotFoundThe specified VSwitch is invalid.The operation failed. The vSwitch ID is invalid. Check the vSwitch ID.
    404InvalidParamThe parameter is invalid.The operation failed. The values of some parameters are invalid.
    404InsufficientResourceCapacityThe target availability zone does not have sufficient resources.The target Availability Zone does not have enough resources.
    404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.The RDS instance cannot be found. Check the ID or name of the RDS instance.

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

    Change history

    Change timeSummary of changesOperation
    2023-12-26The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 403 change
      Error Codes 404 change
    2023-12-12API Description Update. The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 403 change
      Error Codes 404 change
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: PersistentConnectionStatus
    2023-11-23The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: DBProxyInstanceType
    2023-11-14The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
      Added Error Codes: 403
    2023-09-08The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2022-06-08The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: DBProxyEngineType