tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

EnableReplicaReadonly

Last updated: 2024-04-03 11:33:10

    1. API Description

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

    This API is used to enable read/write separation.

    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: EnableReplicaReadonly.
    Version Yes String Common Params. The value used for this API: 2018-04-12.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID
    ReadonlyPolicy.N No Array of String Account routing policy. If master or replication is entered, it means to route to the master or replica node; if this parameter is left empty, it means to write into the master node and read from the replica node by default.

    3. Output Parameters

    Parameter Name Type Description
    Status String Valid values: ERROR, OK. This field has been disused.
    Note: This field may return null, indicating that no valid values can be obtained.
    TaskId Integer Task ID
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Enabling read/write separation

    Input Example

    https://redis.tencentcloudapi.com/?Action=EnableReplicaReadonly
&InstanceId=crs-5a4py64p
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "2d4387ee-2011-449e-a32b-87f9366f3ef4",
        "Status": "OK",
        "TaskId": 21312
    }
}

    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.SystemError Internal system error, which is irrelevant to the business.
    FailedOperation.UnSupportError The instance does not support this API.
    InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
    InternalError.InternalError Internal error.
    InvalidParameter.PermissionDenied The API has no CAM permissions.
    ResourceUnavailable.CallOssError Failed to call the backend API.
    ResourceUnavailable.InstanceConfError An instance configuration error occurred.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy