1. 接口描述
接口请求域名： dcdb.api3.fincloud.tencent.com。
进行实例级别的主备切换
默认接口请求频率限制：20次/秒。
接口更新时间：2023-11-03 19:18:32。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：SwitchDBInstanceHA |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-11 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 实例ID 示例值： tdsqlshard-lfkz0geb |
| Zone | 是 | 否 | String | 切换的目标区域，会自动选择该可用区中延迟最低的节点 示例值： ap-region1-1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowId | Int64 | 异步流程Id 示例值： 10118 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameter.InstanceNotFound | 未找到请求的实例。 |
| InternalError.OperateDatabaseFailed | 数据库操作失败。 |
| ResourceUnavailable.InstanceStatusAbnormal | 数据库实例状态不正确，当前无法操作。 |
| InternalError.InnerSystemError | 内部系统错误。 |
| UnsupportedOperation.OperationNotApplicable | 操作不可执行 |
| InternalError.GetInstanceDetailFailed | 获取实例详情失败。 |
| InvalidParameter.ZoneIdIllegal | 可用区ID不合法 |
| InternalError.CreateFlowFailed | 创建流程失败 |