Modifies the latency threshold of the read/write splitting link and the read weights of a primary instance and its read-only instances.
Operation description
Supported database engines
- MySQL
- SQL Server
Prerequisites
Before you call this operation, make sure that the following requirements are met:
-
The shared proxy feature is enabled for your ApsaraDB RDS for MySQL instance.
-
The read/write splitting feature is enabled for your ApsaraDB RDS for MySQL instance.
-
The instance must run one of the following database engine versions and RDS editions:
- MySQL 5.7 on RDS High-availability Edition with local disks
- MySQL 5.6
- SQL Server on RDS Cluster Edition
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The ID of the primary instance. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5xxxxxxx |
ConnectionStringPrefix | string | No | The prefix of the read/write splitting endpoint. The prefix must be unique. It can be up to 30 characters in length and can contain lowercase letters and hyphens (-). It must start with a lowercase letter. Note
The default prefix consists of the name of the primary instance followed by the letters rw.
| rm-m5xxxxxxxxrw.mysql.rds.aliyuncs.com |
Port | string | No | The port that is associated with the read/write splitting endpoint. | 3306 |
MaxDelayTime | string | No | The latency threshold that is allowed by the read/write splitting link. Unit: seconds. If the latency on a read-only instance exceeds the specified threshold, the system no longer routes read requests to the read-only instance. If you do not specify this parameter, the default value of this parameter is retained. Note
| 12 |
DistributionType | string | No | The method that is used to assign read weights. Valid values:
Note
You must specify at least one of MaxDelayTime and DistributionType.
| Standard |
Weight | string | No | The read weights of the primary instance and its read-only instances. A read weight must be a multiple of 100 and cannot exceed 10,000.
Note
| {"rm-bp1**********":800,"master":400,"slave":400} |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "5A77D650-27A1-4E08-AD9E-59008EDB6927"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | ReadUniformNetTypeNotExists | The specified uniform read only network type does not exist. | The operation failed. The unified network type that you specify for the read-only RDS instances cannot be found. |
400 | ReadDBInstance.NotFound | The Current DB Instance has not read-only instance. | The database instance does not have any read-only instance. |
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. |
For a list of error codes, visit the Service error codes.