tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ChangeReplicaToMaster

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

    1. API Description

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

    This API is used to promote a replica node group to a master node group or a replica node to a master node for an instance.

    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: ChangeReplicaToMaster.
    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 ID of the specified instance, such as "crs-xjhsdj****" Log in to the Redis console and copy the instance ID in the instance list.
    GroupId No Integer ID of the replica node group. You can get more ID information of the multi-AZ replica node group though the DescribeInstanceZoneInfo API. This parameter is not required for a single-AZ replica node group.

    3. Output Parameters

    Parameter Name Type Description
    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 Sample request

    This example shows you how to promote a replica to a master in single AZ or multiple AZs.

    Input Example

    POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: ChangeReplicaToMaster<Common request parameters>{    "InstanceId": "crs-sa5****",    "GroupId": 301524}

    Output Example

    {
    "Response": {
        "RequestId": "c4ed5948-d156-4931-b9c3-10133a0bb6c9",
        "TaskId": 10856
    }
}

    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
    AuthFailure CAM signature/authentication error.
    AuthFailure.InvalidAuthorization Invalid authorization.
    FailedOperation.SystemError Internal system error, which is irrelevant to the business.
    FailedOperation.UnSupportError The instance does not support this API.
    InvalidParameter.IllegalParameterError Invalid parameter.
    InvalidParameter.InvalidParameter Invalid service parameter.
    InvalidParameter.PermissionDenied The API has no CAM permissions.
    InvalidParameterValue Incorrect parameter value.
    ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
    ResourceUnavailable.InstanceStatusError Operation unsupported: the instance is exceptional.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy