SwitchOver--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

SwitchOver

最近更新时间：2024.09.13 11:12:19首次发布时间：2023.09.22 11:08:36

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

请求类型

异步请求。

使用限制

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

注意事项

正在切换的节点将出现秒级的连接闪断，建议在业务低峰期进行切换操作，并确保应用具备自动重连机制。
正在切换的节点会出现短暂的（30 秒内）只读状态，以避免主从切换引起潜在的数据丢失风险和 DNS 缓存引起的数据双写情况。

请求参数

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

返回参数

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

示例

请求示例

POST https://redis.volcengineapi.com/?Action=SwitchOver&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "redis-cn0212gzmh2xs****",
    "TargetPrimaryNodeName": "server-redis-cn0212gzmh2xs****-0-1"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230915202143DA8DBA604CA9E91C****",
        "Action": "SwitchOver",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing",
    },
    "Result": null
}

错误码

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