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

文档中心

立即注册

导航

TestShutDownDBInstanceNodes

最近更新时间：2025.11.25 09:59:42首次发布时间：2025.11.25 09:59:42

调用 TestShutDownDBInstanceNodes 接口为目标 Redis 实例模拟指定 Server 或 Proxy 节点故障切换。

请求类型

异步请求。

使用限制

仅主备类型的 Redis 实例（即调用 DescribeDBInstanceDetail 接口的返回结果中，InstanceClass 返回结果为 PrimarySecondary），支持调用该接口。关于实例类型的更多详情，请参见产品架构。

注意事项

正在切换的节点将出现秒级的连接闪断。
正在切换的节点会出现短暂的（30 秒内）不可写时间，以避免主从切换引起潜在的数据丢失风险和 DNS 缓存引起的数据双写情况。
Pub/Sub 不支持数据持久化，主从切换时订阅缓存区的数据可能存在数据丢失风险。
应用需具备自动重连机制，以及处理异常的能力，否则在实例执行主从切换过程中，应用将提示异常信息，例如 READONLY You can't write against a read only replica。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cnlfkmh6uiii8****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
ServerShardIds	String[]	否	["server-redis-cnlfkmh6uiii8****-0"]	模拟故障发生的 Server 主节点所属的分片 ID。支持同时传入多个分片，多个分片间用英文逗号（,）分隔。说明您可以调用 DescribeDBInstanceShards 接口查询目标 Redis 实例下各 Shard 分片的详情，包括 Shard ID。若该参数留空，表示不为实例中的任何 Server 主节点模拟故障切换。
ProxyNodeIds	String[]	否	["proxy-redis-cnlfkmh6uiii8****-0"]	模拟故障发生的 Proxy 节点 ID。支持同时传入多个节点，多个节点间用英文逗号（,）分隔。说明您可以调用 DescribeNodeIds 接口查询目标实例包含的所有节点信息，包括 Proxy 节点 ID 信息。若该参数留空，表示不为实例中的任何 Proxy 节点模拟故障切换。

返回参数

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

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=TestShutDownDBInstanceNodes&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.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-cnlfkmh6uiii8****",
    "ServerShardIds": [
        "server-redis-cnlfkmh6uiii8****-0"
    ],
    "ProxyNodeIds": [
        "proxy-redis-cnlfkmh6uiii8****-0"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****10023228002****",
        "Action": "TestShutDownDBInstanceNodes",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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