执行主从切换（即切换节点角色），可应用于容灾演练、多可用区场景下的应用就近连接等需求。
接口说明
说明
关于多可用区场景下的应用就近连接的详细说明，请参见场景示例。
调用本接口时，实例类型为高可用或双副本。
调用本接口将产生下述影响：
- 触发节点角色切换后，执行切换的数据节点将出现秒级的只读状态和连接闪断，请确保您的应用具备重连机制。
- 实例处于切换中状态时，您将无法执行实例级别的操作（例如变更配置、迁移可用区等）。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| kvstore:SwitchInstanceHA | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 实例 ID，可调用 DescribeInstances 获取。 | r-bp1zxszhcgatnx**** |
| NodeId | string | 否 | 数据分片节点 ID，您可以调用 DescribeRoleZoneInfo 获取 CustinsId 参数，多个数据分片节点 ID 之间使用英文逗号（,）分隔，如需指定所有节点请输入 说明
当实例为集群或读写分离架构时，本参数才可用，且必填。
| 56****19,56****20 |
| SwitchMode | integer | 否 | 0 | |
| SwitchType | string | 是 | 切换模式，取值：
说明
您需要根据业务场景对数据、服务等方面的需求进行衡量，然后选取切换模式。
| AvailablePriority |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-07-20 | OpenAPI 描述信息更新 | 查看变更详情 |