tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyProxyRwSplit

Last updated: 2024-07-19 11:01:12

    1. API Description

    Domain name for API request: cynosdb.tencentcloudapi.com.

    This API is used to configure the read/write separation of a 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.
    ClusterId Yes String Cluster ID
    ProxyGroupId Yes String Database proxy group ID
    ConsistencyType No String Consistency type. Valid values: eventual (eventual consistency), session (session consistency), global (global consistency).
    ConsistencyTimeOut No String Consistency timeout period
    WeightMode No String Assignment mode of read/write weights. Valid values: system (auto-assigned), custom
    InstanceWeights.N No Array of ProxyInstanceWeight Read-Only weight of an instance
    FailOver No String Whether to enable failover. If it is enabled, the connection address will route requests to the source instance in case of proxy failure. Valid values: true, false.
    AutoAddRo No String Whether to automatically add read-only instances. Valid values: true, false
    OpenRw No String Whether to enable read/write separation
    RwType No String Read/Write type. Valid values:
    READWRITE, READONLY.
    TransSplit No Boolean Transaction split
    AccessMode No String Connection mode. Valid values:
    nearby, balance.
    OpenConnectionPool No String Whether to enable the connection pool. Valid values:
    yes, no.
    ConnectionPoolType No String Connection pool type. Valid values:
    ConnectionPoolType, SessionConnectionPool.
    ConnectionPoolTimeOut No Integer Connection persistence timeout

    3. Output Parameters

    Parameter Name Type Description
    FlowId Integer Async FlowId
    TaskId Integer Async 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 This API is used to configure the read/write separation of a database proxy.

    This API is used to configure the read/write separation of a database proxy.

    Input Example

    POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyProxyRwSplit
<Common request parameters>

{
    "ClusterId": "abc",
    "ProxyGroupId": "abc",
    "ConsistencyType": "abc",
    "ConsistencyTimeOut": "abc",
    "WeightMode": "abc",
    "InstanceWeights": [
        {
            "InstanceId": "abc",
            "Weight": 0
        }
    ],
    "FailOver": "abc",
    "AutoAddRo": "abc",
    "OpenRw": "abc",
    "RwType": "abc",
    "TransSplit": true,
    "AccessMode": "abc",
    "OpenConnectionPool": "abc",
    "ConnectionPoolType": "abc",
    "ConnectionPoolTimeOut": 0
}

    Output Example

    {
    "Response": {
        "FlowId": 0,
        "TaskId": 0,
        "RequestId": "abc"
    }
}

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy