交换实例VIP

最近更新时间:2019-08-15 19:56:41

1. 接口描述

接口请求域名: redis.tencentcloudapi.com 。

在通过DTS支持跨可用区灾备的场景中,通过该接口交换实例VIP完成实例灾备切换。交换VIP后目标实例可写,源和目标实例VIP互换,同时源与目标实例间DTS同步任务断开

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:redis.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SwitchInstanceVip
Version String 公共参数,本接口取值:2018-04-12
Region String 公共参数,详见产品支持的 地域列表
SrcInstanceId String 源实例ID
DstInstanceId String 目标实例ID
TimeDelay Integer 单位为秒。源实例与目标实例间DTS已断开时间,如果DTS断开时间大于TimeDelay,则不切换VIP,建议尽量根据业务设置一个可接受的值。
ForceSwitch Integer 在DTS断开的情况下是否强制切换。1:强制切换,0:不强制切换
SwitchTime String now: 立即切换,syncComplete:等待同步完成后切换

3. 输出参数

参数名称 类型 描述
TaskId Integer 任务ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://redis.tencentcloudapi.com/?Action=SwitchInstanceVip
&SrcInstanceId=crs-5a4py64p
&DstInstanceId=crs-1kl0iy0v
&ForceSwitch=1
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DtsStatusAbnormal 当前DTS状态下不允许该操作。
FailedOperation.SystemError 内部系统错误,和业务无关。
InternalError.DbOperationFailed 统一的 DB 操作错误,可以是 update insert select..。
InternalError.InternalError 内部错误。
InvalidParameterValue.UnSupportedType 实例类型不支持。
ResourceUnavailable.InstanceStateError 实例状态错误。
ResourceUnavailable.InstanceStatusAbnormal redis 状态异常,不能执行对应流程。