调用 SwitchOver 接口切换目标 Redis 实例的主从节点。

请求类型

异步请求。

使用限制

仅主备实例（即 InstanceClass 取值为 PrimarySecondary ）支持调用该接口，单节点实例（即 InstanceClass 取值为 Standalone ）不支持调用该接口。关于两种类型实例的功能特性差异详情，请参见功能特性差异。

注意事项

正在切换的节点将出现秒级的连接闪断，建议在业务低峰期进行切换操作，并确保应用具备自动重连机制。

正在切换的节点会出现短暂的（30 秒内）只读状态，以避免主从切换引起潜在的数据丢失风险和 DNS 缓存引起的数据双写情况。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs1111	实例 ID。说明仅主备实例（即 InstanceClass 取值为 PrimarySecondary ）支持调用该接口，单节点实例（即 InstanceClass 取值为 Standalone ）固定包含 1 个节点，不支持主从节点切换功能。您可以调用 DescribeDBInstances接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
TargetPrimaryNodeIds	Array of String	否	["server-redis-redis-cn0212gzmh2xs****-0-1"]	需要进行批量主从切换的从节点 ID 列表。说明最多支持同时为 50 个分片进行批量切主。批量切主时，最多允许从每个分片中选择 1 个从节点进行切换。 TargetPrimaryNodeIds 和 TargetPrimaryNodeId 参数不允许同时为空；若同时设置了上述两个参数，优先使用 TargetPrimaryNodeIds 所设参数值。传入节点的当前角色必须为从节点（即 CurrentRole 取值为 SecondaryNode ）。您可以调用 DescribeDBInstanceShards接口查询目标 Redis 实例下各 Shard 分片的 Server 节点详情，包括节点 ID 和节点角色。
TargetPrimaryNodeId	String	否	server-redis-cn0212gzmh2xs****-0-1	需要进行主从切换的从节点 ID。说明 TargetPrimaryNodeIds 和 TargetPrimaryNodeId 参数不允许同时为空；若同时设置了上述两个参数，优先使用 TargetPrimaryNodeIds 所设参数值。传入节点的当前角色必须为从节点（即 CurrentRole 取值为 SecondaryNode ）。您可以调用 DescribeDBInstanceShards接口查询目标 Redis 实例下各 Shard 分片的 Server 节点详情，包括节点 ID 和节点角色。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

缓存数据库 Redis 版