All Products
Search
Document Center

ApsaraDB RDS:ModifyDBProxyEndpoint

Last Updated:Jun 13, 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

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:ModifyDBProxyEndpointWrite
  • 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

    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.
    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 user center 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.
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
    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.
    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.
    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.

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

    Change history

    Change timeSummary of changesOperation
    2023-12-19API Description Update. The Error code 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
    2022-06-23API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      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: 403
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: DBProxyEngineType