tencent cloud

APIs

DocumentationAPIsTDSQL-C for MySQLDatabase Proxy APIsModifyProxyRwSplit

ModifyProxyRwSplit

Download
Focus Mode
Font Size
Last updated: 2026-06-08 10:57:37

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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, such as cynosdbmysql-proxy-qwe123
ConsistencyType No String

Consistency Type "eventual"-final consistency, "session"-session consistency, "global"-global consistency
ConsistencyTimeOut No String

Consistency timeout.
Value ranges from 0 to 1000000 (microseconds). When set to 0, it means the request will wait if the read-only instance fails to satisfy the consistency policy due to delay.
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 fault migration is enabled. After a failure occurs, the connection address will be routed to primary instance. Value: "yes", "no"
AutoAddRo No String

Automatically add read-only instance, value: "yes", "no"
OpenRw No String

Whether to enable read-write separation.
This parameter is deprecated. Set the read-write attribute through RwType.
RwType No String

Read-write type:
READWRITE, READONLY
TransSplit No Boolean

Transaction split.
Read and write operations in a transaction are split and executed on different instances.
AccessMode No String

Connection mode:
nearby, balance
OpenConnectionPool No String

Whether to enable the connection pool:
yes, no
ConnectionPoolType No String

Connection pool Type:
SessionConnectionPool
ConnectionPoolTimeOut No Integer

Connection pool time.
Optional range: 0-300 (seconds).
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

3. Output Parameters

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.

4. Example

Example1 Configure Read-Write Separation for Database Proxy

This example shows you how to configure read-write separation for the database proxy.

Input Example

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
}

Output Example

{
    "Response": {
        "FlowId": 134762,
        "TaskId": 146783,
        "RequestId": "a5706353-296a-4992-ad07-ac4a48eeba43"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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 Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FlowCreateError Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InvalidParameter.InvalidParameterError Unknown parameter. Please check whether the parameter is valid.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
OperationDenied.ClusterStatusDeniedError For the cluster in this status, the operation is not allowed.
OperationDenied.InstanceStatusDeniedError For the instance in this status, the operation is not allowed.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.
Previous Topic: CreateProxyEndPointNext Topic: DescribeSaveBackupClusters

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback