有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

该接口 (SwitchDBInstanceMasterSlave) 支持用户主动切换实例主从角色。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SwitchDBInstanceMasterSlave。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID。
示例值:"cdb-xxx"
DstSlave String 目标从实例。可选值:"first" - 第一备机;"second" - 第二备机。默认值为 "first",仅多可用区实例支持设置为 "second"。
示例值:"first"
ForceSwitch Boolean 是否强制切换。默认为 False。注意,若设置强制切换为 True,实例存在丢失数据的风险,请谨慎使用。
示例值:false
WaitSwitch Boolean 是否时间窗内切换。默认为 False,即不在时间窗内切换。注意,如果设置了 ForceSwitch 参数为 True,则该参数不生效。
示例值:false

3. 输出参数

参数名称 类型 描述
AsyncRequestId String 异步任务 ID。
示例值:""
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 切换实例主从角色

输入示例

https://cdb.tencentcloudapi.com/?Action=SwitchDBInstanceMasterSlave
&InstanceId=cdb-xxxxxxxx
&DstSlave=second
&<公共请求参数>

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
CdbError.DatabaseError 后端数据库错误。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.UnknownError 未知错误。
InvalidParameter.ExceptionParam 异常参数。
InvalidParameterValue.InvalidParameterValueError 参数值无效。
OperationDenied 操作被拒绝。
OperationDenied.InstanceStatusError 实例状态异常。
OperationDenied.InstanceUnsupportedOperateError 实例不支持该操作。
ResourceNotFound.CdbInstanceNotFoundError 未找到数据库实例,请确认您的实例状态是否正常。