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

文档中心

缓存数据库 Redis 版

变更实例配置

EnableDBInstanceHA

调用 EnableDBInstanceHA 接口将 Redis 单节点实例变更为主备实例。

请求类型

异步请求。

注意事项

单节点实例变更为主备实例后，实例类型发生了变化，支持的功能也会有差异。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
若在变更为主备实例过程中，还减少了分片数或降低了节点规格，需保证实例当前的已用内存不超过新内存总容量，其中新内存总容量 = 变更后的单分片内存 x 分片数。已用内存信息查看方法，请参见查看实例信息。
说明
您可以在监控告警下的数据节点页签中，查看并确认每个分片的已使用内存指标数据。查看监控数据的方法，请参见查看监控数据。
若变更前的单节点实例为已启用分片集群实例且申请了直连地址，那么在变更为主备实例时：
- 不允许选择不启用分片集群。
- 实例的分片数量不能超过 8 个。如果需要在开启直连地址的场景下增加更多的分片数量，请提交工单联系技术支持。
变更过程中，实例可能会返回 -TRYAGAIN The specific keys are being migrated.\r\n 错误，或出现 1 次 ~ 2 次连接闪断，每次闪断时长在 30 秒内，请谨慎操作。建议在业务低峰期执行变配操作，并确保客户端配置了正确的重试机制。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
ApplyImmediately	Boolean	是	true	是否立即执行配置变更操作。取值范围如下： `true`：立即变更。 `false`：在可维护时间段内执行变更。说明关于可维护时间段的更多信息，请参见设置可维护时间段。
NodeNumber	Integer	是	3	每个分片中的节点数。取值范围为 2~6。说明每个账号在每个地域下默认最多可创建 4 个 256 MiB 规格（即 `ShardCapacity` 取值为 `256`）的节点，若您需要调整 256 MiB 规格节点的购买配额（上限为 10 个），请参见账号配额。
ShardedCluster	Integer	是	1	是否启用分片集群。取值范围如下： `0`：不启用。 `1`：启用。说明若变更前的单节点实例为已启用分片集群实例且申请了直连地址，那么在变更为主备实例时，不允许选择不启用分片集群。
ShardNumber	Integer	否	3	实例中的分片数量。取值范围为 2~256。说明仅当启用分片集群（即 `ShardedCluster` 取值为 `1`）时，需要指定该参数。您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息，包括实例是否已启用分片以及分片数量。若需要缩减分片数量，需保证实例当前的已用内存不超过新内存总容量，其中新内存总容量 = 变更后的单分片内存 x 分片数。已用内存信息查看方法，请参见查看实例信息。若变更前的单节点实例为已启用分片集群实例且申请了直连地址，那么在变更为主备实例时，实例的分片数量不能超过 8 个。如果需要在开启直连地址的场景下增加更多的分片数量，请提交工单联系技术支持。
ShardCapacity	Integer	否	1024	每个分片的内存容量，单位：MiB。取值范围如下：若实例为未启用分片集群（即 `ShardedCluster` 取值为 `0` ），每分片内存容量可选取值为：256，512，1024，2048，4096，8192，16384，32768，24576，65536。若实例为启用分片集群（即 `ShardedCluster` 取值为 `1`）时，每分片内存容量可选取值为：1024，2048，4096，8192，16384。说明若该参数留空，表示不修改实例的内存容量。您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息，包括实例是否开启分片，以及每个分片中的内存容量。若需要缩小分片容量，需保证实例当前的已用内存不超过新内存总容量，其中新内存总容量 = 变更后的单分片内存 x 分片数。已用内存信息查看方法，请参见查看实例信息。每种实例规格都有对应支持的分片容量和带宽，因此修改实例分片容量的同时，也会同步修改实例的带宽和规格。关于 Redis 实例规格的更多详情，请参见产品规格。
MultiAZ	String	否	enabled	设置实例的可用区部署方案。取值范围如下： `disabled`：单可用区部署方案。 `enabled`：多可用区部署方案。说明若该参数留空，表示不修改实例的可用区部署方案。关于可用区部署方案的更多说明，请参见多可用区同城容灾解决方案。
ConfigureNodes	Object[]	否		设置节点所属的可用区列表。说明若该参数留空，表示不修改实例节点所属的可用区。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

参数	类型	示例值	描述
OrderNO	String	Order702856788643751****	订单号。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=EnableDBInstanceHA&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-cn0212gzmh2xs****",
    "ApplyImmediately": true,
    "ShardNumber": 3,
    "NodeNumber": 3,
    "ShardedCluster": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420800210023228002****",
        "Action": "EnableDBInstanceHA",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "OrderNO": "Order702856788643751****"
    }
}

错误码

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

最近更新时间：2026.04.14 11:02:29

这个页面对您有帮助吗？

有用

无用

缓存数据库 Redis 版

请求类型 #

注意事项 #

调试 #

请求参数 #

返回参数 #

示例 #

请求示例 #

返回示例 #

错误码 #