All Products
Search
Document Center

ApsaraDB RDS:ModifyDBProxyEndpoint

更新時間:Nov 11, 2024

Modifies the connection settings for a database proxy endpoint.

Operation description

Supported database engines

  • RDS MySQL
  • RDS PostgreSQL

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:ModifyDBProxyEndpointupdate
  • 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-bp145737x5bi6****
DBProxyEndpointIdstringNo

The ID of the proxy endpoint. You can call the DescribeDBProxyEndpoint operation to query the proxy endpoint ID.

Note
  • If the instance runs MySQL and you set DbEndpointOperator to Delete or Modify, you must specify DBProxyEndpointId.
  • If the instance runs PostgreSQL and you set DbEndpointOperator to Delete, Modify, or Create, you must specify DBProxyEndpointId.
  • gos787jog2wk0y****
    ConfigDBProxyFeaturesstringNo

    The features that you want to enable for the proxy endpoint. If you specify more than one feature, separate the features with semicolons (;). Format: Feature 1:Status;Feature 2:Status;.... Do not add a semicolon (;) at the end of the value.

    Valid feature values:

    • ReadWriteSpliting: read/write splitting
    • ConnectionPersist: connection pooling
    • TransactionReadSqlRouteOptimizeStatus: transaction splitting

    Valid status values:

    • 1: enabled
    • 0: disabled
    Note If the instance runs PostgreSQL, you can enable only the read/write splitting feature, which is specified by ReadWriteSpliting.
    ReadWriteSpliting:1;ConnectionPersist:0
    RegionIdstringNo

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

    cn-hangzhou
    ReadOnlyInstanceMaxDelayTimestringNo

    The latency threshold that is allowed for read/write splitting. If the latency on a read-only instance exceeds the threshold that you specified, the system no longer forwards read requests to the read-only instance. Unit: seconds If you do not specify this parameter, the original value of this parameter is retained. Valid values: 0 to 3600. Default value: 30.

    Note You must specify this parameter only when the read/write splitting feature is enabled.
    30
    ReadOnlyInstanceDistributionTypestringNo

    The policy that is used to allocate read weights. Valid values:

    • Standard: The system automatically allocates read weights to the instance and its read-only instances based on the specifications of the instances.
    • Custom: You must manually allocate read weights to the instance and its read-only instances.
    Note You must specify this parameter only when the read/write splitting feature is enabled. For more information about the permission allocation policy, see Modify the latency threshold and read weights of ApsaraDB RDS for MySQL instances and Enable and configure the database proxy feature for an ApsaraDB RDS for PostgreSQL instance.
    Standard
    ReadOnlyInstanceWeightstringNo

    The read weights of the instance and its read-only instances. A read weight must be a multiple of 100 and cannot exceed 10000. Formats:

    • Standard instance: {"ID of the primary instance":"Weight","ID of the read-only instance":"Weight"...}

      Example: {"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}

    • Instance on RDS Cluster Edition: {"ID of the read-only instance":"Weight","DBClusterNode":{"ID of the primary node":"Weight","ID of the secondary node":"Weight","ID of the secondary node":"Weight"...}}

      Example: {"rr-tfhfgk5****":"200","DBClusterNode":{"rn-2z****":"0","rn-2z****":"400","rn-2z****":"400"...}}

      Note DBClusterNode is required if the instance runs RDS Cluster Edition. The DBClusterNode parameter includes information about IDs and weights of the primary and secondary nodes..
    {"rm-uf6wjk5xxxx":"500","rr-tfhfgk5xxx":"200"...}
    DbEndpointOperatorstringNo

    The type of operation that you want to perform. Valid values:

    • Modify: Modify a proxy terminal. This is the default value.
    • Create: Create a proxy terminal.
    • Delete: Delete a proxy terminal.
    Modify
    DbEndpointAliasesstringNo

    The description of the proxy terminal.

    test-proxy
    DbEndpointTypestringNo

    The type of the proxy terminal. This is a reserved parameter. You do not need to specify this parameter.

    RWSplit
    DbEndpointReadWriteModestringNo

    The read and write attributes of the proxy terminal. Valid values:

    • ReadWrite: The proxy terminal connects to the primary instance and can receive both read and write requests.
    • ReadOnly: The proxy terminal does not connect to the primary instance and can receive only read requests. This is the default value.
    Note
  • If you set DbEndpointOperator to Create, you must also specify DbEndpointReadWriteMode.
  • If the instance runs MySQL and you change the value of this parameter from ReadWrite to ReadOnly, the transaction splitting feature is disabled.
  • ReadWrite
    DBProxyEngineTypestringNo

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

    normal
    VSwitchIdstringNo

    Specifies the switch ID corresponding to the availability zone of the proxy connection address. By default, it is the switch ID corresponding to the default terminal of the proxy instance. You can query the created switch by calling the DescribeVSwitches interface.

    vsw-uf6adz52c2p****
    EffectiveTimestringNo

    Effective time, value:

    • Immediate: effective immediately.

    • MaintainTime: effective during the operational and maintainable time period, see ModifyDBInstanceMaintainTime.

    • SpecificTime: effective at a specified time.

    Default value: MaintainTime.

    MaintainTime
    EffectiveSpecificTimestringNo

    The specified time takes effect. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).

    Note This parameter must be passed when EffectiveTime is SpecificTime.
    2023-05-06T07:08:09Z

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "6B50D92C-1960-4D4F-A290-AFADD6B1A5C8"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidVpcInstanceIdThe specified VPC instance ID is invalid.-
    400InvalidEndPoint.FormatThe specified EndPoint is not valid.-
    400InvalidEndpointType.FormatThe specified EndpointType is invalid.The value of the EndpointType parameter is invalid. Check the value of this parameter.
    400IncorrectDBInstanceNetTypeThe current database instance network type does not support the operation.The operation failed. The operation is not supported for the network type of the RDS instance.
    400EndpointNum.ErrorThe number of endpoint is invalid.The number of proxy terminals is not supported. Check the maximum number of proxy terminals that are allowed.
    400EndpointTypeOperation.NotSupportThe endpoint type does not support the operation.The operation is not supported for the type of proxy terminal that you configure.
    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.
    400ClusterEndpoint.StatusNotValidThe cluster endpoint status is invalid.The status of the endpoint is invalid.
    400MaxscaleNotSupportCurrent custins can not support Maxscale.This operation is not supported for instances with maxscale.
    400InvalidAvZone.FormatSpecified AvZone is not valid.The value of the AvZone parameter is invalid. Check the value of this parameter.
    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.
    403MaxScaleLevel.NotSupportThe current maxscale ins_num does not support this operation.The operation failed. The specifications of the database proxy are low.
    403ReadDBInstance.NotFoundThe current database instance does not contain any read only instance.The current database instance does not have a read-only instance.
    403IncorrectKindCodeThe current KindCode of the custins does not support the operation.-
    403IncorrectDBInstanceStateThe current database instance state does not support the operation.The operation failed. The RDS instance is not running.
    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.
    403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
    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.
    403InvalidVswitchIdSpecified conn vswitch id is not valid.-
    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.
    404EndpointConfig.InvalidPlease check the endpoint config parameter.Please check the endpoint configuration parameter.
    404Readins.NotFoundThe current instance does not contain any read only instance. The operation is not supported.The operation failed. The RDS instance is not attached with read-only RDS instances.
    404Endpoint.NotFoundSpecified endpoint is not found.The port that is associated with the dedicated proxy endpoint cannot be found.
    404EndpointType.NotFoundThe specified endpoint type is not found.The operation failed. Unknown types of proxy terminals are detected.
    404InvalidReadDBInstance.NotFoundThe specified read only database instance does not exist.The read-only RDS instance is not created, or the values of the request parameters are invalid.
    404InvalidParamThe specified Weight is invalid.The weight is invalid.
    404Maxscale.NotFoundThe related maxscale instance is not found.The operation failed. No associated MaxScale instances can be found.
    404IncorrectVswitchIdThe specified parameter VSwitchId is not valid.The vSwitch ID is invalid.
    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-19API Description Update. The Error code has changedView Change Details
    2022-06-23API Description Update. The Error code has changedView Change Details
    2022-06-08The Error code has changed. The request parameters of the API has changedView Change Details