Changes the configuration of a database proxy for an instance.
Operation description
Supported database engines
- MySQL
- PostgreSQL
Note
Starting October 17, 2023, ApsaraDB RDS for MySQL instances that run RDS Cluster Edition offer one free-of-charge dedicated database proxy for each unit in phases. For more information, see [Special offers/Price changes] One dedicated proxy is provided free of charge for ApsaraDB RDS for MySQL instances on RDS Cluster Edition.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| rds:ModifyDBProxyInstance | update |
|
| none |
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-t4n3a**** |
| DBProxyInstanceType | string | Yes | The database proxy type. Valid values:
| DedicatedProxy |
| DBProxyInstanceNum | string | Yes | The number of database proxies. If you set this parameter to 0, the database proxy feature is disabled for the instance. Valid values: 1 to 16. Note
The capability of the database proxy feature to process requests increases with the number of database proxies that are enabled. You can monitor the load on the instance and specify an appropriate number of database proxies based on the load monitoring data.
| 2 |
| EffectiveTime | string | No | The effective time. Valid values:
Default value: MaintainTime. | MaintainTime |
| EffectiveSpecificTime | string | No | The point in time that you want to specify. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note
If the EffectiveTime parameter is set to SpecificTime, you must specify this parameter.
| 2019-07-10T13:15:12Z |
| RegionId | string | No | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| DBProxyEngineType | string | No | A deprecated parameter. You do not need to specify this parameter. | normal |
| VSwitchIds | string | No | The ID of the vSwitch in the destination zone. You can call the DescribeVSwitches operation to query existing vSwitches. Note
Only database proxies for ApsaraDB RDS for MySQL instances that use cloud disks can be migrated to different zones.
| vsw-uf6adz52c2p**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "65C55572-530E-4A53-BE03-1D08CAF0F046"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 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 | InvalidParameters.Format | Specified parameter is not valid | The operation failed. The values of some parameters are invalid. |
| 400 | InvalidAvZone.Format | Specified AvZone is not valid. | The value of the AvZone parameter is invalid. Check the value of this parameter. |
| 400 | ErrorMxsServiceInsNum.Error | The Maxscale serviceIns num must be 1. | - |
| 400 | TaskExists | Specified task have existed. | The task already exists. |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | A package instance is not allowed to operate independently. |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | Pricing plan price result not found. |
| 400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication. |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | Your account available limit is less than 0, please recharge before trying to purchase. |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | Failed to call commodity service return. |
| 400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support. |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | The module you purchased is not legal, please buy it again. |
| 400 | RegionEndTimeDissolvedIndia | Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. | Hello customer, this area has been abolished. |
| 400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. |
| 400 | Price.CommoditySys | Commodity system call exception. | Commodity system call exception. |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | Insufficient available balance. |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | There is a problem with the period you selected, please choose again. |
| 400 | pay.noCreditCard | Account not bound to credit card. | - |
| 400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | - |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | Your basic information is not complete, please complete your basic information before operation. |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | Your account is abnormal, please contact customer service for details. |
| 400 | BasicInfoUncompleted | Your information is incomplete, Complete your information before the operation. | - |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | A system error occurs when the sales expression is verified. |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor. |
| 403 | DBInstanceStatusNotActive | Current DB instance status should be active. | The operation failed. Check the status of the RDS instance. |
| 403 | InvalidInstanceLevel.Malformed | The 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. |
| 403 | NotHaveProxy | The current instance does not have a proxy. | - |
| 403 | MaxscaleMinorVersionNotSupport | The Maxscale version used by the instance is too low, please upgrade the Maxscale version first. | The version of the database proxy used by the instance is too low. Upgrade the version of the database proxy first. |
| 403 | IncorrectDBInstanceType | Current DB instance engine and type does not support operations. | 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 | IncorrectDBType | The current DB type does not support this operation. | The operation failed. The operation is not supported by the database engine of the RDS instance. Specify a different database engine. |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
| 403 | InvalidKmsKey | Kms key is disabled. | - |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | - |
| 403 | DBInstanceStatusNotActive | The status of the current instance is not active. | The operation failed. Check the status of the RDS instance. |
| 403 | IncorrectDBInstance | The current DB instance does not support this operation. | The operation failed. The operation is not supported for the RDS instance. |
| 403 | MaxscaleInstanceNotSupport | Instances with maxscale instance do not support this operation. | - |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | The instance has an unpaid order. Please pay first and try again. |
| 404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | The operation failed. The RDS instance is locked. |
| 404 | InvalidDBInstanceClass.NotFound | Specified DB instance class is not found. | The configuration or the instance type cannot be found or has been discontinued. Specify a different configuration or a different instance type. |
| 404 | InsufficientResourceCapacity | The target availability zone does not have sufficient resources. | The target Availability Zone does not have enough resources. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-12 | The Error code has changed | View Change Details |
| 2024-05-07 | The Error code has changed | View Change Details |
| 2024-04-25 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2024-01-09 | The Error code has changed | View Change Details |
| 2023-12-19 | API Description Update. The Error code has changed | View Change Details |
| 2023-05-15 | The Error code has changed | View Change Details |
| 2022-06-23 | API Description Update. The Error code has changed | View Change Details |
| 2022-06-07 | The Error code has changed. The request parameters of the API has changed | View Change Details |