Queries system-assigned read weights.
Operation description
Supported database engines
- MySQL
- SQL Server
Feature description
When the read/write splitting feature is enabled, this operation is used to calculate system-assigned read weights. For more information about custom read weights, see DescribeDBInstanceNetInfo .
Prerequisites
Before you call this operation, make sure that the following requirements are met:
-
If the instance runs MySQL, the instance uses a shared proxy.
-
The instance runs one of the following MySQL 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
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The primary instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5xxxxxxx |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "C816A4BF-A6EC-4722-95F9-2055859CCFD2",
"Items": {
"DBInstanceWeight": [
{
"ReadonlyInstanceSQLDelayedTime": "30",
"Weight": "100",
"DBInstanceType": "Master",
"DBInstanceId": "rm-uf6wjk5xxxxxxx"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
403 | IncorrectDBInstanceType | Current DB instance engine and type does not support operations. | The operation failed. The operation is not supported for the database engine of the RDS instance. |
403 | IncorrectDBInstanceConnType | Current DB instance conn type does not support this operation. | The operation is not supported for the connection type of the RDS instance. |
403 | IncorrectDBType | The current DB type does not support this operation. | The operation failed. The operation is not supported by the database engine of the RDS instance. Specify a different database engine. |
404 | InvalidDBInstanceName.NotFound | Invalid DBInstanceId NotFound. | The instance ID cannot be found. |
404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | The operation failed. The RDS instance is locked. |
404 | InvalidDBInstanceClass.NotFound | Specified DB instance class is not found. | The configuration or the instance type cannot be found or has been discontinued. Specify a different configuration or a different instance type. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2022-08-12 | The response structure of the API has changed | View Change Details |