You need to enable JavaScript to run this app.
文档中心
缓存数据库 Redis 版

缓存数据库 Redis 版

复制全文
下载 pdf
变更实例配置
ModifyDBInstanceShardCapacity
复制全文
下载 pdf
ModifyDBInstanceShardCapacity
调用 ModifyDBInstanceShardCapacity 修改目标 Redis 实例的单分片内存容量。​
请求类型​
异步请求。​
注意事项​
  • 变更单分片内存容量过程中,实例可能会出现最多 1 次连接闪断,闪断时长在 30 秒内,请谨慎操作。建议在业务低峰期执行变配操作,并确保客户端配置了正确的重试机制。关于不同类型 Redis 实例支持的变配方案以及不同变更操作的影响详情,请参见变配方案。​
  • 开启数据闪回后,发起配置变更将自动关闭数据闪回功能。数据闪回功能关闭后,之前的闪回时间点不再保留。您需要在配置变更完成后再调用 StartContinuousBackup 接口开启数据闪回功能。更多详情,请参见设置数据闪回功能。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
InstanceId​
String​
是​
redis-cn0212gzmh2xs****​
实例 ID。​
说明​
您可以调用 DescribeDBInstances接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。​
ApplyImmediately​
Boolean​
是​
true​
是否立即执行配置变更操作。取值范围如下:​
  • true:立即变更。​
  • false:在可维护时间段内执行变更。​
说明​
关于可维护时间段的更多信息,请参见设置可维护时间段。​
ShardCapacity​
Long​
是​
1024​
每个分片的内存容量,单位:MiB。取值范围如下:​
  • 若实例为未启用分片集群(即 ShardedCluster 取值为 0 ),每分片内存容量可选取值为:256,512,1024,2048,4096,8192,16384,32768,24576,65536。​
  • 若实例为启用分片集群(即 ShardedCluster 取值为 1)时,每分片内存容量可选取值为:1024,2048,4096,8192,16384。​
说明​
  • 您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息,包括实例是否开启分片,以及每个分片中的内存容量。​
  • 若需要缩小分片容量,需保证实例当前的已用内存不超过新内存总容量(总容量 = 单分片容量 x 分片数量)的 85%。​
  • 每种实例规格都有对应支持的分片容量和带宽,因此修改实例分片容量的同时,也会同步修改实例的带宽和规格。关于 Redis 实例规格的更多详情,请参见产品规格。​
CreateBackup​
Boolean​
否​
false​
是否在变更前创建备份。取值范围如下:​
  • true:创建备份。​
  • false(默认):不创建。​
说明​
  • 该参数仅对主备实例(即InstanceClass为PrimarySecondary)生效。单节点实例(即InstanceClass为Standalone) 不支持备份功能,无需设置该参数。​
BackupPointName​
String​
否​
testbackup​
为变更前创建的全量备份设置备份名称。备份名称需同时满足如下条件:​
  • 以中文、字母、下划线(_)开头。​
  • 长度为 1-128 个字符。​
  • 由中文、字母、数字、下划线(_)和中划线(-)组成。​
说明​
  • 仅当选择了需要在变更前创建备份(即CreateBackup为true)时,该参数生效。​
  • 若不设置备份名称,默认使用备份 ID 作为名称。​
ReserveAdditionalBandwidth​
Boolean​
否​
false​
设置是否保留额外带宽。取值范围如下:​
  • true(默认):保留额外带宽。​
  • false:不保留额外带宽。​
说明​
  • 该参数仅当实例中存在额外带宽时生效。您可以调用 DescribeDBInstanceBandwidthPerShard 接口查询目标 Redis 的单分片带宽详情,包括默认带宽和额外带宽。​
  • 保留额外带宽时将遵循如下规则:​
  • 实例的单分片总带宽 = 变更后节点规格的默认带宽 + 额外带宽。​
  • 额外带宽 = min[ 单分片当前的额外带宽, 变更后节点规格所允许的最大额外带宽 ]。​
  • 关于修改带宽的更多详情,请参见修改带宽。​
ClientToken​
String​
否​
WbiAlPqJM6tMoSOYhT****​
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
OrderNO​
String​
Order716987014301057****​
订单编号。​
​
示例​
请求示例​
​
POST https://redis.cn-beijing.volcengineapi.com/?Action=ModifyDBInstanceShardCapacity&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****",​
"ShardCapacity": 16384,​
"ApplyImmediately": true​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202211251645030101742511840602xxxx",​
"Action": "ModifyDBInstanceShardCapacity",​
"Version": "2020-12-07",​
"Service": "Redis",​
"Region": "cn-beijing"​
},​
"Result": {​
"OrderNO": "Order716987014301057****"​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.09.21 14:23:31
这个页面对您有帮助吗?
有用
有用
无用
无用