All Products
Search
Document Center

ApsaraDB RDS:ModifyDBProxyEndpoint

Last Updated:May 29, 2023

Modifies the proxy endpoint that is used to connect to the dedicated proxy of an instance.

Operation Description

Before you call the ModifyDBProxyEndpoint operation, make sure that the ModifyDBProxy operation is called to enable the database proxy feature for the instance.

  • The dedicated proxy feature of ApsaraDB RDS for MySQL provides capabilities such as read/write splitting and short-lived connection optimization. For more information, see What are database proxies?
  • The database proxy feature of ApsaraDB RDS for PostgreSQL supports read/write splitting. For more information, see What are database proxies?

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
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

rm-bp145737x5bi6****
DBProxyEndpointIdstringYes

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

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 last value.

Valid feature values:

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

Valid status values:

  • 1: enabled
  • 0: disabled
NoteIf 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 of the instance. You can call the DescribeRegions operation to query 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.

NoteYou 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.
NoteYou 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-uf6wjk5xxxx":"500","rr-tfhfgk5xxx":"200"...}

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

    Example: {"rr-tfhfgk5xxx":"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

An internal parameter. You do not need to specify this parameter.

normal

Response parameters

ParameterTypeDescriptionExample
object
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.
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.
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.

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

Change history

Change timeSummary of changesOperation
2022-06-23API Description Update,The error codes of the API operation change.
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
2022-06-08The error codes of the API operation change.,The input parameters of the API operation change.
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: DBProxyEngineType