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

文档中心

立即注册

导航

ModifyDBInstanceAdditionalBandwidthPerShard

最近更新时间：2024.07.18 23:07:42首次发布时间：2023.06.23 11:23:25

调用 ModifyDBInstanceAdditionalBandwidthPerShard 接口修改目标 Redis 实例的单分片额外带宽。

请求类型

同步请求。

注意事项

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

计费说明

关于额外带宽的计费规则和价格的详细说明，请参见额外带宽计费规则。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
AdditionalBandwidth	Integer	是	2	设置单分片的额外带宽，即在默认带宽基础上需要额外增加的带宽，单位：MB/s。额外带宽取值需同时满足如下条件：需大于等于 0，取值为 0 时表示不增加附加带宽，单分片带宽即为默认带宽。附加带宽加默认带宽的总和不可超过当前实例允许修改的带宽上限。不同规格节点允许修改的带宽上限不同，更多详情请参见带宽修改范围。实例总写带宽和实例总读带宽的上限均为 2048MB/s。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

参数	类型	示例值	描述
OrderNO	String	Order217500000099909****	订单 ID。

示例

请求示例

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": "202407162055504B5C0337ED26FA2B05DD-ea4af2",
        "Action": "ModifyDBInstanceAdditionalBandwidthPerShard",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "OrderNO": "Order217500000099909****"
    }
}

错误码

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