tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for Redis®
    Documentation
    Download PDF

    ChangeMasterInstance

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

      1. API Description

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

      This API is used to set a read-only instance in a replication group as a master 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: ChangeMasterInstance.
      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.
      GroupId Yes String Replication group ID, such as crs-rpl-m3zt****. It is the unique identifier automatically assigned by the system when creating a replication group. Log in to the TencentDB for Redis console, and get it in the global replication list.
      InstanceId Yes String ID of the read-only instance to be promoted to the master instance, such as crs-xjhsdj****. Log in to the the TencentDB for Redis console, and copy it in the instance list.
      ForceSwitch No Boolean Whether to promote the read-only instance to the master instance forcibly. Valid values:
      - true: Yes
      - false: No

      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 set a read-only instance in a replication group as a master instance.

      Input Example

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

{
    "InstanceId": "crs-sa5****",
    "GroupId": "crs-rpl-sa5****",
    "ForceSwitch": false
}

      Output Example

      {
    "Response": {
        "TaskId": 327,
        "RequestId": "e546784b-709c-401d-aba6-73037eb4e522"
    }
}

      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.
      InvalidParameter.PermissionDenied The API has no CAM permissions.
      InvalidParameterValue.CheckNotPass Business verification failed
      InvalidParameterValue.ReplicationGroupNotExists The global replication group doesn’t exist.
      LimitExceeded.ReplicationGroupLocked Replication group locked
      ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
      ResourceUnavailable.InstanceStatusError Operation unsupported: the instance is exceptional.
      UnsupportedOperation.Inspection Inspecting replication group
      UnsupportedOperation.InstanceNotOperation Unsupported operation
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy