SwitchDBInstanceMasterSlave

Last updated: 2021-04-15 16:40:34

1. API Description

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

This API is used for source-to-replica switch.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: SwitchDBInstanceMasterSlave.
Version Yes String Common parameter. The value used for this API: 2017-03-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID
DstSlave No String Specifies the replica server to switched to. Valid values: first (the first replica server), second (the second replica server). Default value: first. second is valid only for a multi-AZ instance.
ForceSwitch No Boolean Whether to force the switch. Valid values: True, False (default). If this parameter is set to True, instance data may be lost during the switch.
WaitSwitch No Boolean Whether to perform the switch during a time window. Valid values: True, False (default). If ForceSwitch is set to True, this parameter is invalid.

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async task ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Performing a source-replica switch

Input Example

https://cdb.tencentcloudapi.com/?Action=SwitchDBInstanceMasterSlave
&InstanceId=cdb-xxxxxxxx
&DstSlave=second
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "faae8d6a-38fb-44de-988e-5a0e78aba4a7",
    "AsyncRequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
  }
}

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
CdbError.DatabaseError Backend database error.
InternalError.DatabaseAccessError Internal database error.
InternalError.UnknownError Unknown error
OperationDenied Operation denied.
ResourceNotFound.CdbInstanceNotFoundError The instance cannot be found. Please check whether your instance status is normal.