文档

EnableAdditionalBandwidth - 调整实例带宽

更新时间:

调整Redis实例的带宽。

接口说明

若您在调用本接口的同时,开启了实例带宽弹性伸缩功能,则实例会优先使用带宽弹性伸缩功能,且在带宽弹性回缩时,将回缩至实例规格的默认带宽。更多关于该功能限制、费用说明及常见问题,请参见调整实例带宽

说明 调用本接口前,您可以调用 DescribeRoleZoneInfo 查询实例中各数据节点的当前带宽。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:EnableAdditionalBandwidthWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID,可调用 DescribeInstances 获取。

r-bp1zxszhcgatnx****
CouponNostring

优惠券编号。

youhuiquan_promotion_option_id_for_blank
AutoPayboolean

是否自动付款,取值:

  • true:默认值,自动付款,请确保账号有足够的余额。
  • false:手动付款。您需要在控制台的顶部菜单栏,单击费用 > 续费管理,然后单击左侧导航栏的订单管理 > 我的订单,找到目标订单进行支付。
true
NodeIdstring

数据分片 ID,您可以调用 DescribeLogicInstanceTopology 获取,传入多个时使用英文逗号(,)分隔;您也可以传入 All(即表示所有数据分片)。

说明 当 Redis 实例为集群架构读写分离架构时,本参数才可用且必须传入。
r-bp1zxszhcgatnx****-db-0
Bandwidthstring

要增加的带宽,单位为 MB/s。取值为大于等于 0 的整数 ,最大可传入该实例(或单分片)规格默认带宽的 6 倍,但上限为 192MB/s。例如实例默认带宽为 10 MB/s,本参数的取值范围为 0~60

说明
  • 您可以调用 DescribeRoleZoneInfo 接口,通过返回参数 DefaultBandWidth 获取默认最大带宽。更多关于实例规格的信息,请参见实例规格查询导航
  • 如果请求参数 NodeId 传入了多个数据分片 ID,本参数传入的带宽值需和数据分片 ID 的顺序对应,多个带宽值之间使用英文逗号(,)分隔。
  • 20
    OrderTimeLengthstring

    购买的时长,单位为天,取值:12371430609018036573010951825

    说明 如果需要继续使用购买的带宽,您需要在带宽到期前调用 RenewAdditionalBandwidth 接口及时续费。
    30
    SourceBizstring

    调用来源,本参数仅用于内部维护使用,无需传入。

    SDK
    AutoRenewboolean

    是否开启自动续费,取值:

    • true:开启。
    • false:不开启,默认值。
    false
    AutoRenewPeriodinteger

    自动续费周期,单位为月,取值:12345678912243660

    说明
  • AutoRenew 参数取值为 true 时,本参数才可用且必须传入。
  • 该参数设置后暂不支持通过 API 查询,您可以在控制台的顶部菜单栏,单击费用 > 续费管理,然后在实例 ID文本框中输入实例 ID 加-bw后缀(例如 r-bp1zxszhcgatnx****-bw)来查询。
  • 1
    ChargeTypestring

    额外增加带宽的付费类型,取值:

    • PrePaid:预付费,即包年包月,仅该类型需要传入 OrderTimeLengthAutoRenew 参数。
    • PostPaid:按量付费。
    PrePaid

    返回参数

    名称类型描述示例值
    object
    OrderIdstring

    订单 ID。

    2084452111111
    RequestIdstring

    请求 ID。

    D622714-AEDD-4609-9167-F5DDD3D1****

    示例

    正常返回示例

    JSON格式

    {
      "OrderId": "2084452111111",
      "RequestId": "D622714-AEDD-4609-9167-F5DDD3D1****"
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-06-06OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:ChargeType
    • 本页导读 (1)
    文档反馈