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

文档中心

立即注册

导航

TestFailoverDBInstanceZone

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

调用 TestFailoverDBInstanceZone 接口为目标 Redis 实例模拟可用区级别故障切换。

请求类型

异步请求。

使用限制

仅部署了多可用区的 Redis 实例（即调用 DescribeDBInstanceDetail 接口的返回结果中，MultiAZ 返回结果为 enabled），支持调用该接口。更多详情，请参见部署多可用区。

注意事项

可用区级别故障切换过程中，实例可能会出现 1~2 次连接闪断，每次闪断时长在 30 秒内，请谨慎操作，并确保客户端配置了正确的重试机制。
可用区级别故障切换所需时间会受多种因素（如网络环境、任务队列、数据量大小等）影响，建议在业务低峰期执行操作。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cnlfkmh6uiii8****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
FailedZoneId	String	是	cn-beijing-a	模拟故障发生的可用区 ID。说明您可以调用 DescribeZones 接口查询 Redis 在指定地域下的所有可用区信息，包括可用区 ID。
FailbackToPrimaryDelayInMinutes	Long	否	5	自动切换回主可用区前的故障持续时间。单位：分钟。取值范围如下： 5。 10。 15。说明仅当为实例的主可用区（即调用 DescribeDBInstanceDetail 接口的返回结果中， `ZoneIds` 返回的第一个可用区）模拟故障切换时，该参数生效。若该参数留空，表示不需要自动切换回主可用区。那么故障切换完成后，可能出现主节点位于备可用区，备节点位于主可用区的情况。您可以在故障切换完成后，调用 ModifyDBInstanceAZConfigure 接口手动切换实例的可用区。

返回参数

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

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=TestFailoverDBInstanceZone&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****",
    "FailedZoneId": "cn-beijing-a",
    "FailbackToPrimaryDelayInMinutes": 5
}

返回示例

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

错误码

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