All Products
Search
Document Center

ApsaraDB RDS:ModifyDBProxy

Last Updated:Nov 07, 2024

Enables or modifies the database proxy feature 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.

References

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ModifyDBProxyupdate
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
  • rds:InstanceNetworkType
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 feature.
  • Shutdown: disables the feature.
  • Modify: modifies the configuration of the 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 deprecated parameter. You do not need to specify this parameter.

normal
DBProxyInstanceTypestringNo

The database proxy type. Valid values:

  • common: general-purpose database proxy
  • exclusive (default): dedicated database proxy
common
ResourceGroupIdstringNo

The resource group ID.

rg-acfmy*****
PersistentConnectionStatusstringNo

Specifies whether to enable persistent connections. Valid values:

  • Enabled
  • Disabled
Note
  • This parameter is available only for instances that run MySQL.

  • If you want to modify persistent connections, you must set the ConfigDBProxyService parameter to Modify.

Enabled
DBProxyNodesarray<object>No

The proxy nodes.

objectNo

The details of the proxy node.

cpuCoresstringNo

The number of CPU cores of the node. Valid values: 1 to 16.

Note This parameter is required when you configure the DBProxyNodes parameter.
1
nodeCountsstringNo

The number of proxy nodes in the zone. Valid values: 1 and 2.

Note This parameter is required when you configure the DBProxyNodes parameter.
2
zoneIdstringNo

The ID of the zone in which the node resides.

Note This parameter is required when you configure the DBProxyNodes parameter.
cn-hagnzhou-c

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.
400InvalidDBProxyNodes.Generalgeneral-purpose proxy does not support more than 2 nodes.Generic proxy does not support more than 2 nodes.
400InvalidDBProxyNodes.ZoneIdAndNodeCountsThe number of node count and zone count is mismatch.The number of zones or nodes is invalid.
400InvalidDBProxyNodes.ZoneIdThe number of zone is request 1 or 2.The ZoneId of the DBProxyNodes field can only be one or two zones.
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou 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.
400InsufficientAvailableQuotaYour 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.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
400RegionDissolvedEOMDear 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.
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
400RegionEndTimeDissolvedAustraliaCloud 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.
400Price.CommoditySysCommodity system call exception.Commodity system call exception.
400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
400pay.noCreditCardAccount not bound to credit card.-
400Order.InstHasUnpaidOrderThere 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.
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
400Api.NotSupportSpecified api is not supported.The current interface does not support.
400ContainForbiddenLabelErrorThere 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.
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400KmsApiErrorUser secret key invalid.The user key is invalid.
400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.The current instance engine version not support coldDataEnabled.
400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.The current instance minor version not support coldDataEnabled.
400IncorrectTargetClasscodeThe current instance type does not support this operation.This operation is not supported by the instance type.
400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.The link address name is duplicate. Please reset the connection string.
400RequiredParam.NotFoundRequired input param is not found.-
400Parameters.InvalidParameter error, please check the parameters.Parameter error, please check the parameters.
400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400InvalideStatus.FormatThe instance status does not support this operation.-
400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.Specified Released Keep Policy is not valid.
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
400Pay.NoCreditCardNo credit cards.No credit cards.
400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.The vpc network type instance does not support this operation.
400MirrorInsExistsSpecified DB instance mirror ins already existed.Specified DB instance mirror ins already existed.
400UnsupportedClassCodeThe specified DB instance class stops selling.The specified DB instance class stops selling.
400InvalidBackupSetThe specified database does not exist in the backup set.The specified database does not exist in the backup set.
400OrdTCommodityQueryErrorFailed to query for product.Failed to query product.
400ProductInstanceReleasedThe instance has been released. Please check before placing the order.The instance has been released, please verify and place an order.
400RegionEndTimeDissolvedIndiaThe region is no longer supported.The region is no longer supported.
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.-
403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
403OperationDenied.ZoneResourceThere is no available zone for inventory.There is no available zone for inventory.
403NotInFlowControllerSorry,no permission.Sorry,no permission.
403InvalidKmsKeyKms key is disabled.-
403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.The specified database instance type does not support this operation.
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.
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
404Request.NotFoundThe requested resource is not available.The requested resources are unavailable.
404HostInfo.NotFoundThe specified host info is not found.-
500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.
500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.The service request failed. Please try again later or contact service personnel.
500InvokeProxyFailureThe request processing has failed due to service failure of rds api.The request failed to be processed due to an RDS API failure.

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

Change history

Change timeSummary of changesOperation
2024-10-15The Error code has changed. The request parameters of the API has changedView Change Details
2023-12-26The Error code has changedView Change Details
2023-12-12API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details
2023-11-23The Error code has changed. The request parameters of the API has changedView Change Details
2023-11-14The Error code has changedView Change Details
2023-09-08The Error code has changedView Change Details
2022-06-08The Error code has changed. The request parameters of the API has changedView Change Details