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