Modifies the proxy terminal configurations of a dedicated proxy for an ApsaraDB RDS 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?
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 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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
rds:ModifyDBProxyEndpoint | WRITE |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance. | rm-bp145737x5bi6**** |
DBProxyEndpointId | string | Yes | The ID of the proxy endpoint. You can call the DescribeDBProxyEndpoint operation to query the ID of the proxy endpoint. Note
| gos787jog2wk0y**** |
ConfigDBProxyFeatures | string | No | The features that you want to enable for the proxy endpoint. If you specify more than one feature, separate the features with semicolons (;). Format: Valid feature values:
Valid status values:
Note
If the instance runs PostgreSQL, you can enable only the read/write splitting feature, which is specified by ReadWriteSpliting.
| ReadWriteSpliting:1;ConnectionPersist:0 |
RegionId | string | No | The region ID of the instance. You can call the DescribeRegions operation to query most recent region list. | cn-hangzhou |
ReadOnlyInstanceMaxDelayTime | string | No | 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 |
ReadOnlyInstanceDistributionType | string | No | The policy that is used to allocate read weights. Valid values:
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 |
ReadOnlyInstanceWeight | string | No | 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:
| {"rm-uf6wjk5xxxx":"500","rr-tfhfgk5xxx":"200"...} |
DbEndpointOperator | string | No | The type of operation that you want to perform. Valid values:
| Modify |
DbEndpointAliases | string | No | The description of the proxy terminal. | test-proxy |
DbEndpointType | string | No | The type of the proxy terminal. This is a reserved parameter. You do not need to specify this parameter. | RWSplit |
DbEndpointReadWriteMode | string | No | The read and write attributes of the proxy terminal. Valid values:
Note
| ReadWrite |
DBProxyEngineType | string | No | An internal parameter. You do not need to specify this parameter. | normal |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "6B50D92C-1960-4D4F-A290-AFADD6B1A5C8"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidVpcInstanceId | The specified VPC instance ID is invalid. | - |
400 | InvalidEndPoint.Format | The specified EndPoint is not valid. | - |
400 | InvalidEndpointType.Format | The specified EndpointType is invalid. | The value of the EndpointType parameter is invalid. Check the value of this parameter. |
400 | IncorrectDBInstanceNetType | The 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. |
400 | EndpointNum.Error | The number of endpoint is invalid. | The number of proxy terminals is not supported. Check the maximum number of proxy terminals that are allowed. |
400 | EndpointTypeOperation.NotSupport | The endpoint type does not support the operation. | The operation is not supported for the type of proxy terminal that you configure. |
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 | ClusterEndpoint.StatusNotValid | The cluster endpoint status is invalid. | The status of the endpoint is invalid. |
403 | MaxScaleLevel.NotSupport | The current maxscale ins_num does not support this operation. | The operation failed. The specifications of the database proxy are low. |
403 | ReadDBInstance.NotFound | The current database instance does not contain any read only instance. | The current database instance does not have a read-only instance. |
403 | IncorrectKindCode | The current KindCode of the custins does not support the operation. | - |
403 | IncorrectDBInstanceState | The current database instance state does not support the operation. | The operation failed. The RDS instance is not running. |
404 | EndpointConfig.Invalid | Please check the endpoint config parameter. | Please check the endpoint configuration parameter. |
404 | Readins.NotFound | The 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. |
404 | Endpoint.NotFound | Specified endpoint is not found. | The port that is associated with the dedicated proxy endpoint cannot be found. |
404 | EndpointType.NotFound | The specified endpoint type is not found. | The operation failed. Unknown types of proxy terminals are detected. |
404 | InvalidReadDBInstance.NotFound | The 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. |
404 | InvalidParam | The specified Weight is invalid. | The weight is invalid. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2022-06-23 | API Description Update,The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
2022-06-08 | The error codes of the API operation change.,The input parameters of the API operation change. | see changesets | ||||||||||||
|