1. 接口描述
接口请求域名： redis.tencentcloudapi.com 。
在通过DTS支持跨可用区灾备的场景中，通过该接口交换实例VIP完成实例灾备切换。交换VIP后目标实例可写，源和目标实例VIP互换，同时源与目标实例间DTS同步任务断开
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SwitchInstanceVip。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SrcInstanceId | 是 | String | 源实例ID 示例值：crs-5a4py64p |
| DstInstanceId | 是 | String | 目标实例ID 示例值：crs-1kl0iy0v |
| TimeDelay | 否 | Integer | 单位为秒。源实例与目标实例间DTS已断开时间，如果DTS断开时间大于TimeDelay，则不切换VIP，建议尽量根据业务设置一个可接受的值。 示例值：100 |
| ForceSwitch | 否 | Integer | 在DTS断开的情况下是否强制切换。1：强制切换，0：不强制切换 示例值：1 |
| SwitchTime | 否 | String | now: 立即切换，syncComplete：等待同步完成后切换 示例值：now |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 任务ID 示例值：18491 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DtsStatusAbnormal | 当前DTS状态下不允许该操作。 |
| FailedOperation.SystemError | 内部系统错误，和业务无关。 |
| InternalError.DbOperationFailed | 统一的 DB 操作错误，可以是 update insert select..。 |
| InternalError.InternalError | 内部错误。 |
| InvalidParameter.InvalidParameter | 业务参数错误。 |
| InvalidParameterValue.UnSupportedType | 实例类型不支持。 |
| ResourceUnavailable.InstanceStateError | 实例状态错误。 |
| ResourceUnavailable.InstanceStatusAbnormal | redis 状态异常，不能执行对应流程。 |
