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
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5xxxxxxx |
| ConfigDBProxyService | string | Yes | Specifies whether to enable or disable the database proxy feature. Valid values:
| Startup |
| DBProxyInstanceNum | string | No | 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 |
| RegionId | string | No | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| InstanceNetworkType | string | No | 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 |
| VPCId | string | No | 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 |
| VSwitchId | string | No | 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 |
| DBProxyEngineType | string | No | A reserved parameter. You do not need to specify this parameter. | normal |
| DBProxyInstanceType | string | No | This parameter is reserved. You do not need to specify this parameter. | common |
| ResourceGroupId | string | No | The resource group ID. | rg-acfmy***** |
| PersistentConnectionStatus | string | No | Whether to enable connection keep. Valid values:
Note
| Enabled |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "FC452BB1-EED8-4278-95C7-0324B3710DF1"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | MaxscaleAlreadyExist | The Maxscale is already existed. | The specified Maxscale already exists. |
| 400 | MaxscaleNotSupport | Maxscale not supported | Dedicated proxy is not supported by the instance. Please check the configuration information about enabling dedicated proxy. |
| 400 | NetWork.NotFound | NetWork.NotFound | The network is unavailable. |
| 400 | InvalidVpcParameter | Either VPC ID or vSwitch ID is incorrect. Please check again. | The operation failed. Check the value of the VPCId parameter. |
| 400 | MaxscaleInternalError | Database proxy status is CLASS_CHANGING. | The specifications of the database proxy are being changed. Restart the RDS instance later. |
| 400 | InvalidDBInstanceName | Specified 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. |
| 400 | InvalidOptimizationCategory.Format | Specified optimization category is not valid. | The specified OptimizationCategory parameter is invalid. |
| 400 | MinorVersionNotSupport | The current database minor version does not support the operation. | The operation is not supported for the minor engine version of the instance. |
| 400 | InvalidParameters.Format | Specified parameter is not valid | The operation failed. The values of some parameters are invalid. |
| 400 | MaxscaleNotSupport | Current custins can not support Maxscale. | This operation is not supported for instances with maxscale. |
| 400 | InvalidTunnelId | Specified conn tunnel is not valid. | - |
| 400 | InvalidRegion.Format | Specified Region is not valid. | The region ID is invalid. Check the region ID. |
| 403 | InvalidConnVPCId | Specified conn vpc id is not valid. | The specified VPC ID is invalid. |
| 403 | IncorrectDBInstanceType | The database instance type does not support the operation. | The operation failed. The operation is not supported for the database engine of the RDS instance. |
| 403 | IncorrectDBInstanceEngine | Current 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. |
| 403 | IncorrectKindCode | Current 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. |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | - |
| 404 | MaxscaleCreating | The relative maxscale instance is being created or deleted. | - |
| 404 | Maxscale.NotFound | The relative maxscale instance is not found. | No associated maxscale instance is found. |
| 404 | InvalidVSwitchId.NotFound | The specified VSwitch is invalid. | The operation failed. The vSwitch ID is invalid. Check the vSwitch ID. |
| 404 | InvalidParam | The parameter is invalid. | The operation failed. The values of some parameters are invalid. |
| 404 | InsufficientResourceCapacity | The target availability zone does not have sufficient resources. | The target Availability Zone does not have enough resources. |
| 404 | InvalidDBInstance.NotFound | The 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 time | Summary of changes | Operation |
|---|---|---|
| 2023-12-26 | The Error code has changed | View Change Details |
| 2023-12-12 | API Description Update. The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-11-23 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-11-14 | The Error code has changed | View Change Details |
| 2023-09-08 | The Error code has changed | View Change Details |
| 2022-06-08 | The Error code has changed. The request parameters of the API has changed | View Change Details |