调用 ModifyDBInstanceAdditionalBandwidthPerShard 接口修改目标 Redis 实例的单分片额外带宽。
请求类型
同步请求。
注意事项
- 仅创建时间在 2023 年 05 月 25 日之后的实例才支持修改带宽功能。创建时间早于 2023 年 05 月 25 日的实例如需修改分片带宽,需先创建一个新实例,在新实例上使用该功能。您可以通过 DTS 等工具将旧实例数据迁移至新实例,具体操作步骤,请参见数据迁移。
- 增加带宽不会对业务造成影响。减少带宽前请关注业务当前带宽,以免触发带宽限流。
- 若您在修改带宽后又执行了如下任一操作,实例带宽配置将遵循如下规则:
- 变更实例的分片集群配置
未启用分片集群变更为启用分片集群后,实例的单分片带宽 = 启用分片集群时所选节点规格对应的默认带宽。 - 按备份集恢复到新实例或按时间点恢复到新实例
按备份集或时间点恢复到新实例时,原实例的带宽配置不会应用到新实例中,新实例使用所选节点规格对应的默认带宽。 - 恢复已删除实例
通过备份集将已删除实例数据恢复到一个新实例时,已删除实例的带宽配置不会应用到新实例中,新实例使用所选节点规格对应的默认带宽。 - 购买相同配置实例
根据已有实例配置创建一个新实例时,原实例的带宽配置不会应用到新实例中,新实例使用所选节点规格对应的默认带宽。
- 若您在修改带宽后还需要变更节点规格,您可以在变更节点规格时通过勾选额外带宽来保留额外带宽,保留额外带宽时将遵循如下规则:
- 实例的单分片总带宽 = 变更后节点规格的默认带宽 + 额外带宽。
- 额外带宽 = min[ 单分片当前的额外带宽, 变更后节点规格所允许的最大额外带宽 ]。
- 带宽会受到 CPU 转发能力的限制,带宽的最高上限与 CPU 的最高上限,以先达到瓶颈者为准,因此可能出现 CPU 利用率达 100%,但带宽利用率未达 100% 的情况。请合理规划使用带宽,更多详情,请参见合理使用带宽建议。
计费说明
额外带宽实行梯度计费,即带宽单价会随额外带宽的增加而增大。更多关于额外带宽的价格详情,请参见额外带宽计费规则。
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
去调试请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
InstanceId | String | 是 | redis-cn0212gzmh2xs**** | |
AdditionalBandwidth | Integer | 否 | 2 | 设置单分片的额外读、写带宽。设置之后,单分片的额外读、写带宽均为所设数值。单位:MB/s。
说明
- 推荐优先使用
AdditionalWriteBandwidth 和 AdditionalReadBandwidth 参数来设置单分片的额外读、写带宽。
- 若未设置
AdditionalWriteBandwidth 或 AdditionalReadBandwidth 参数,则会使用 AdditionalBandwidth 所设数值为单分片的额外读、写带宽。
|
AdditionalWriteBandwidth | Integer | 否 | 2 | 设置单分片的额外写带宽,即在默认带宽基础上需要额外增加的写带宽,单位:MB/s。
额外写带宽取值需同时满足如下条件:
- 需大于等于 0,取值为 0 时表示不增加额外写带宽,单分片带宽即为默认写带宽。
- 额外写带宽加默认带宽的总和不可超过当前实例允许修改的带宽上限。关于带宽上限的更多详情,请参见带宽修改范围。
- Redis 实例整体的带宽最大不可超过 2.5GB/s。因此,实例整体的带宽上限 = min[(分片数 x 单分片带宽上限),2.5GB/s]。更多详情,请参见带宽说明。
|
AdditionalReadBandwidth | Integer | 否 | 2 | 设置单分片的额外读带宽,即在默认带宽基础上需要额外增加的读带宽,单位:MB/s。
额外读带宽取值需同时满足如下条件:
- 需大于等于 0,取值为 0 时表示不增加额外读带宽,单分片带宽即为默认读带宽。
- 额外读带宽加默认带宽的总和不可超过当前实例允许修改的带宽上限。关于带宽上限的更多详情,请参见带宽修改范围。
- Redis 实例整体的带宽最大不可超过 2.5GB/s。因此,实例整体的带宽上限 = min[(分片数 x 单分片带宽上限),2.5GB/s]。更多详情,请参见带宽说明。
|
ClientToken | String | 否 | WbiAlPqJM6tMoSOYhT**** | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
|---|
OrderNO | String | Order217500000099909**** | 订单 ID。 |
示例
请求示例
POST https://redis.cn-beijing.volcengineapi.com/?Action=ModifyDBInstanceAdditionalBandwidthPerShard&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****",
"AdditionalWriteBandwidth": 2,
"AdditionalReadBandwidth": 2
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202407162055504B5C0337ED26FA2B05DD-ea****",
"Action": "ModifyDBInstanceAdditionalBandwidthPerShard",
"Version": "2020-12-07",
"Service": "Redis",
"Region": "cn-beijing"
},
"Result": {
"OrderNO": "Order217500000099909****"
}
}
错误码
更多详情,请参见错误码。