Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to configure read-write separation for database proxy.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ModifyProxyRwSplit. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| ClusterId | Yes | String | Cluster ID, for example, cynosdbmysql-asd123 |
| ProxyGroupId | Yes | String | Database Proxy Group ID, for example, cynosdbmysql-proxy-qwe123 |
| ConsistencyType | No | String | Consistency type; "eventual"-final consistency, "session"-session consistency, "global"-global consistency |
| ConsistencyTimeOut | No | String | Consistency timeout. Value range: 0–1000000 (ms). If set to 0, requests will wait indefinitely when a read-only instance has a delay that causes the consistency policy to fail. |
| WeightMode | No | String | Read-write weight allocation mode; system auto-assignment: "system", custom: "custom" |
| InstanceWeights.N | No | Array of ProxyInstanceWeight | Instance Read-Only Weight. |
| FailOver | No | String | Whether failover is enabled. After a fault occurs on the proxy, the connection address will be routed to the primary instance. Value: "yes", "no" |
| AutoAddRo | No | String | Whether to automatically add read-only instance. Parameter Value: "yes", "no" |
| OpenRw | No | String | Whether to enable read-write separation. |
| RwType | No | String | Read-write type: |
| TransSplit | No | Boolean | Transaction split. |
| AccessMode | No | String | Connection mode: |
| OpenConnectionPool | No | String | Whether to enable connection pool: |
| ConnectionPoolType | No | String | Connection pool type: |
| ConnectionPoolTimeOut | No | Integer | Connection pool time. |
| ApNodeAsRoNode | No | Boolean | Whether to treat the libra node as an ordinary RO node |
| ApQueryToOtherNode | No | Boolean | Whether to forward to other nodes when a libra node fault occurs |
| LoadBalanceMode | No | String | Load balancing mode Enumeration values:
|
| TransAllSplit | No | Boolean | Whether to enable full transactional split. In a transaction, split the reads before and after the write to different instances for execution. |
| Parameter Name | Type | Description |
|---|---|---|
| FlowId | Integer | Async FlowId |
| TaskId | Integer | Asynchronous task ID. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Configure read-write separation for database proxy
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyProxyRwSplit
<Common request parameters>
{
"ClusterId": "cynosdbmysql-dnofdr2d",
"ProxyGroupId": "cynosdbmysql-proxy-4378e0kd",
"ConsistencyType": "eventual",
"ConsistencyTimeOut": "10",
"WeightMode": "system",
"InstanceWeights": [
{
"InstanceId": "cynosdbmysql-ins-c2twj0qf",
"Weight": 0
}
],
"FailOver": "",
"AutoAddRo": "yes",
"OpenRw": "yes",
"RwType": "READONLY",
"TransSplit": true,
"AccessMode": "nearby",
"OpenConnectionPool": "yes",
"ConnectionPoolType": "SessionConnectionPool",
"ConnectionPoolTimeOut": 0
}{
"Response": {
"FlowId": 134762,
"TaskId": 146783,
"RequestId": "a5706353-296a-4992-ad07-ac4a48eeba43"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.DatabaseAccessError | Database access failed. Try again later. If the issue persists, contact customer service. |
| FailedOperation.FlowCreateError | Failed to create the process. Please retry later. If the issue continues, contact customer service. |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the issue persists, contact customer service. |
| FailedOperation.ProxyGroupRwSplitNoRoInstanceError | When the proxy group is set to read-only mode, the cluster must contain at least one read-only instance. |
| InvalidParameter.InvalidParameterError | Unknown parameter. Check whether the parameter is valid. |
| InvalidParameterValue.InvalidParameterValueError | Parameter value is invalid. |
| OperationDenied.ClusterStatusDeniedError | Operation not allowed in the current status of the cluster. |
| OperationDenied.InstanceStatusDeniedError | Operation not allowed in the current instance status. |
| ResourceNotFound.InstanceNotFoundError | The instance does not exist. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan