SwitchInstanceVip

Last updated: 2020-07-31 11:08:57

1. API Description

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

This API is used to swap the VIPs of instances for instance disaster recovery switch in scenarios where cross-AZ disaster recovery is supported through DTS. After the VIPs of the source and target instances are swapped, the target instance can be written into and the DTS sync task between them will be disconnected.

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: redis.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: SwitchInstanceVip.
Version Yes String Common parameter. The value used for this API: 2018-04-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
SrcInstanceId Yes String Source instance ID.
DstInstanceId Yes String Target instance ID.
TimeDelay No Integer The time that lapses in seconds since DTS is disconnected between the source instance and the target instance. If the DTS disconnection time period is greater than TimeDelay, the VIP will not be switched. We recommend setting an acceptable value based on the actual business conditions.
ForceSwitch No Integer Whether to force the switch when DTS is disconnected. Valid values: 1 (yes), 0 (no).
SwitchTime No String Valid values: now (switch now), syncComplete (switch after sync is completed).

3. Output Parameters

Parameter Name Type Description
TaskId Integer Task ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

https://redis.tencentcloudapi.com/?Action=SwitchInstanceVip
&SrcInstanceId=crs-5a4py64p
&DstInstanceId=crs-1kl0iy0v
&ForceSwitch=1
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "9a6bd110-20fc-4e08-b77b-a5656cb6150c",
    "TaskId": 18491
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.DtsStatusAbnormal This operation is not allowed under the current DTS state.
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
InternalError.InternalError Internal error.
InvalidParameterValue.UnSupportedType The instance type is not supported.
ResourceUnavailable.InstanceStateError Instance status error.
ResourceUnavailable.InstanceStatusAbnormal The Redis status is exceptional, and the corresponding process cannot be executed.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help