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

文档中心

立即注册

导航

ModifyDBInstanceShardNumber

最近更新时间：2024.07.18 22:55:12首次发布时间：2022.12.12 14:05:53

调用 ModifyDBInstanceShardNumber 接口修改目标 Redis 实例的分片数量。

请求类型

异步请求。

使用限制

针对启用分片集群实例，若实例已申请了直连地址，那么在变更实例配置时，实例的分片数量不能超过 8 个（即 ShardNumber 取值不能大于 8）。如果需要在开启直连地址的场景下增加更多的分片数量，请提交工单联系技术支持。

注意事项

仅启用分片集群（即 ShardedCluster 为 1）的实例支持修改分片数量。未启用分片集群（即 ShardedCluster 为 0）的实例固定只包含 1 个分片，不支持修改分片数量。更多详情，请参见变更分片数。
变更分片数量过程中，实例可能会返回 -TRYAGAIN The specific keys are being migrated.\r\n 错误，或出现 1~2 次连接闪断，每次闪断时长在 30 秒内，请谨慎操作。建议在业务低峰期执行变配操作，并确保客户端配置了正确的重试机制。关于不同类型 Redis 实例支持的变配方案以及不同变更操作的影响详情，请参见变配方案。
开启数据闪回后，发起配置变更将自动关闭数据闪回功能。数据闪回功能关闭后，之前的闪回时间点不再保留。您需要在配置变更完成后再调用 StartContinuousBackup 接口开启数据闪回功能。更多详情，请参见设置数据闪回功能。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
ApplyImmediately	Boolean	是	true	是否立即执行配置变更操作。取值范围如下： `true`：立即变更。 `false`：在可维护时间段内执行变更。关于可维护时间段的更多信息，请参见设置可维护时间段。
ShardNumber	Integer	是	3	实例中的分片数量。取值范围为 2~256。说明您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息，包括实例是否已启用分片以及分片数量。若需要缩减分片数量，需保证实例当前的已用内存不超过新内存总容量（总容量 = 单分片容量 x 分片数量）的 70%。
CreateBackup	Boolean	否	false	是否在变更前创建备份。取值范围如下： `true`：创建备份。 `false`（默认值）：不创建。说明该参数仅对主备实例（即 `InstanceClass` 为 `PrimarySecondary`）生效。单节点实例（即 `InstanceClass` 为 `Standalone`）不支持备份功能，无需设置该参数。您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息，包括实例类型。
BackupPointName	String	否	testbackup	为变更前创建的全量备份设置备份名称。备份名称需同时满足如下条件: 以中文、字母、下划线（_）开头。长度为 1-128 个字符。由中文、字母、数字、下划线（_）和中划线（-）组成。说明仅当选择了需要在变更前创建备份（即 `CreateBackup` 为 `true`）时，该参数生效。若不设置备份名称，默认使用备份 ID 作为名称。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyDBInstanceShardNumber&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****",
	"ShardNumber": 3,
	"ApplyImmediately": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202211251651380102251460630500****",
        "Action": "ModifyDBInstanceShardNumber",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
 "Result": {
          "OrderNO": "Order716986992383818****"
     }
}

错误码

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