You need to enable JavaScript to run this app.
导航
EnableShardedCluster
最近更新时间:2024.05.10 10:17:10首次发布时间:2023.06.23 11:23:25

调用 EnableShardedCluster 接口变更将指定未启用分片集群实例变更为启用分片集群实例。

请求类型

异步请求。

注意事项

  • 未启用分片集群变更为启用分片集群后,不支持再变更回未启用分片集群。
  • 未启用分片集群变更为启用分片集群操作仅改变实例的架构,实例类型、所在可用区、连接地址等均不会改变。
  • 变更过程中,实例可能会返回 -TRYAGAIN The specific keys are being migrated.\r\n 错误,或出现 1~2 次连接闪断,每次闪断时长在 30 秒内,请谨慎操作。建议在业务低峰期执行变配操作,并确保客户端配置了正确的重试机制。
  • 开启数据闪回后,发起配置变更将自动关闭数据闪回功能。数据闪回功能关闭后,之前的闪回时间点不再保留。更多详情,请参见设置数据闪回功能
  • 仅未启用分片集群实例支持调用 EnableShardedCluster 接口。更多详情,请参见变更实例的分片集群配置

请求参数

参数类型是否必选示例值描述

InstanceId

String

redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。

ApplyImmediately

Boolean

true

是否立即执行配置变更操作。取值范围如下:

  • true:立即变更。
  • false:在可维护时间段内执行变更。关于可维护时间段的更多信息,请参见设置可维护时间段

ShardedCluster

Integer

1

是否启用分片集群。取值范围如下:

  • 0:不启用。
  • 1:启用。

说明

当前仅支持将未启用分片集群变更为启用分片集群实例,故取值必须为 1

ShardNumber

Integer

2

实例中的分片数量。取值范围为 2~256。

说明

仅当 ShardedCluster 取值为 1(即启用分片集群)时,需要指定该参数。

CreateBackup

Boolean

true

是否在变更前创建全量备份。取值范围如下:

  • true:创建备份。
  • false(默认):不创建。

说明

仅 Redis 主备实例(即 InstanceClass 取值为 PrimarySecondary)支持该参数。单节点实例(即 InstanceClass 取值为 Standalone)不支持备份功能,无需设置该参数。

BackupPointName

String

b-cn02xmmrp751i9cdzcphjmk4****

为变更前创建的全量备份设置备份名称。若不设置备份名称,默认使用备份 ID 作为名称。
如需设置备份名称,名称需同时满足如下条件:

  • 以中文、字母、下划线(_)开头。
  • 长度为 1-128 个字符。
  • 由中文、字母、数字、下划线(_)和中划线(-)组成。

说明

仅当选择了需要在变更前创建备份(即 CreateBackup 为 true)时,该参数生效。

ShardCapacity

Integer

1024

每个分片的内存容量,单位:MiB。取值范围为 1024,2048,4096,8192,16384。
实例原单分片容量会影响该参数的默认值,具体说明如下:

  • 若实例原单分片容量为 256,启用分片集群后的 ShardCapacity 默认值为 1024。
  • 若实例原单分片容量为 1024,2048,4096,8192 或 16384,启用分片集群后的 ShardCapacity 默认值和原单分片容量保持一致。
  • 若实例原单分片容量为 32768 或 65536,启用分片集群后的 ShardCapacity 必填,无默认值。

说明

  • 您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息,包括每个分片中的内存容量。
  • 若需要缩小分片容量,需保证实例当前的已用内存不超过新内存总容量(总容量 = 单分片容量 x 分片数量)的 70%。
  • 每种实例规格都有对应支持的分片容量和带宽,因此修改实例分片容量的同时,也会同步修改实例的带宽和规格。关于 Redis 实例规格的更多详情,请参见实例规格
ClientTokenStringWbiAlPqJM6tMoSOYhT****用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。

返回参数

参数类型示例值描述
OrderNOStringOrder716986589022527****订单编号。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=EnableShardedCluster&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****",
        "ApplyImmediately": true,
        "ShardedCluster":1,
        "ShardNumber":2,
        "CreateBackup": true
}

返回示例

{
        "ResponseMetadata": {
                "RequestId": "20230509153711EDF4F0D1DBEFA625****",
                "Action": "EnableShardedCluster",
                "Version": "2020-12-07",
                "Service": "Redis",
                "Region": "cn-beijing"
        },
        "Result": {
                "OrderNO": "Order723108288213844****"
        }
}

错误码

更多详情,请参见错误码