You need to enable JavaScript to run this app.
导航
缓存数据库 Redis 版
  • 文档首页
    • /
  • 缓存数据库 Redis 版

ModifyDBInstanceAdditionalBandwidthPerShard

最近更新时间：2024.02.07 12:41:55

首次发布时间：2023.06.23 11:23:25

我的收藏

调用 ModifyDBInstanceAdditionalBandwidthPerShard 接口修改指定实例的单分片带宽。

请求类型

同步请求。

注意事项

  • 仅创建时间在 2023 年 05 月 25 日之后的实例才支持修改带宽功能。创建时间早于 2023 年 05 月 25 日的实例如需修改分片带宽，需先创建一个新实例，在新实例上使用该功能。您可以通过 DTS 等工具将旧实例数据迁移至新实例，具体操作步骤，请参见数据迁移。
  • 增加带宽不会对业务造成影响。减少带宽前请关注业务当前带宽，以免触发带宽限流。
  • 若您在修改带宽后，若您又执行了如下任一操作，修改后的带宽配置不会应用到新实例或变更后的实例中：
    • 变更节点规格
      变更节点规格之后，实例的单分片带宽 = max[ 节点规格变更后的默认带宽，单分片当前带宽 ]
    • 变更实例的分片集群配置
      未启用分片集群变更为启用分片集群后，实例的单分片带宽 = 启用分片集群时所选节点规格对应的默认带宽。
    • 按备份集恢复到新实例或按时间点恢复到新实例
      按备份集或时间点恢复到新实例时，原实例的带宽配置不会应用到新实例中，新实例使用所选节点规格对应的默认带宽。
    • 恢复已删除实例
      通过备份集将已删除实例数据恢复到一个新实例时，已删除实例的带宽配置不会应用到新实例中，新实例使用所选节点规格对应的默认带宽。
    • 购买相同配置实例
      根据已有实例配置创建一个新实例时，原实例的带宽配置不会应用到新实例中，新实例使用所选节点规格对应的默认带宽。

请求参数

名称类型是否必选示例值描述

InstanceId

String

是

redis-cn0212gzmh2xs****

实例 ID。

说明

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

AdditionalBandwidth

Integer

是

2

设置单分片的附加带宽，即在默认带宽基础上需要额外增加的带宽，取值需同时满足如下条件：

  • 需大于等于 0，取值为 0 时表示不增加附加带宽，单分片带宽即为默认带宽。
  • 附加带宽加默认带宽的总和不可超过当前实例节点的带宽上限。不同规格节点允许修改的带宽上限不同，更多详情请参见带宽修改范围。
  • 实例总写带宽和实例总读带宽的上限均为 2048MB/s。
ClientTokenString否WbiAlPqJM6tMoSOYhT****用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回数据

null

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyDBInstanceAdditionalBandwidthPerShard&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-cnlfiylbrpcua****",
    "AdditionalBandwidth": 2
}

返回示例

正常返回示例

{
     "ResponseMetadata": {
          "RequestId": "202204151542510102120972070662****",
          "Action": "ModifyDBInstanceAdditionalBandwidthPerShard",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing"
     },
     "Result": null
}

错误码

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