All Products
Search

This Product

    Tair:EnableAdditionalBandwidth

    Document Center

    Tair:EnableAdditionalBandwidth

    Last Updated:May 07, 2024

    Adjusts the bandwidth of an ApsaraDB for Redis instance.

    Operation description

    If you enable the bandwidth auto scaling feature and call this operation at the same time, bandwidth auto scaling takes precedence. During bandwidth scale-back, the instance is scaled back to the default bandwidth of the instance type. For more information about the limits, costs, and FAQ about this feature, see Adjust the bandwidth of an instance.

    Note Before you call this operation, you can call the DescribeRoleZoneInfo operation to query the current bandwidth of each data node in an instance.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    kvstore:EnableAdditionalBandwidthWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the instance. You can call the DescribeInstances operation to query the IDs of instances.

    		r-bp1zxszhcgatnx****
    CouponNostringNo

    The coupon ID.

    		youhuiquan_promotion_option_id_for_blank
    AutoPaybooleanNo

    Specifies whether to enable automatic payment. Default value: true. Valid values:

    • true: enables automatic payment. Make sure that you have sufficient balance within your account.
    • false: disables automatic payment. If automatic payment is disabled, you must perform the following steps to complete the payment in the ApsaraDB for Redis console: In the top navigation bar, choose Expenses > Renewal Management. In the left-side navigation pane, click Orders. On the Orders page, find the order and complete the payment.
    		true
    NodeIdstringNo

    The ID of the data shard for which you want to purchase a specific amount of bandwidth. You can call the DescribeLogicInstanceTopology operation to query the IDs of the data shards in an instance. If you specify multiple data shard IDs, separate the data shard IDs with commas (,). You can also set this parameter to All, which specifies all the data shards of the instance.

    Note This parameter is available and required only if the instance is a cluster master-replica or read/write splitting instance.
    		r-bp1zxszhcgatnx****-db-0
    BandwidthstringYes

    The amount of extra bandwidth that you want to purchase. Unit: Mbit/s. The value must be an integer greater than or equal to 0. The maximum value can be up to six times the default bandwidth of the instance or a single shard, but cannot exceed 192 Mbit/s. For example, if the default bandwidth of an instance is 10 Mbit/s, the value range of this parameter is 0 to 60.

    Note

    • You can call the DescribeRoleZoneInfo operation to obtain the default maximum bandwidth returned by the DefaultBandWidth response parameter. For more information about instance types, see Overview .

    • If you specify multiple data shard IDs in the NodeId parameter, you must specify the amount of bandwidth that you want to purchase for each specified data shard in the Bandwidth parameter. The bandwidth values that you specify in the Bandwidth parameter must be in the same sequence as the data shard IDs that you specify in the NodeId parameter. In addition, you must separate the bandwidth values with commas (,).

    		20
    OrderTimeLengthstringNo

    The validity period of the bandwidth that you purchase. Unit: day. Valid values: 1, 2, 3, 7, 14, 30, 60, 90, 180, 365, 730, 1095, and 1825.

    Note If you want to continue using the purchased bandwidth after the specified period of time elapses, you must call the RenewAdditionalBandwidth operation to submit a renewal order.
    		30
    SourceBizstringNo

    The source of the operation. This parameter is used only for internal maintenance. You do not need to specify this parameter.

    		SDK
    AutoRenewbooleanNo

    Specifies whether to enable auto-renewal. Valid values:

    • true: enables auto-renewal.
    • false: disables auto-renewal. This is the default value.
    		false
    AutoRenewPeriodintegerNo

    The auto-renewal cycle based on which ApsaraDB for Redis automatically renews the purchased bandwidth. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, and 60.

    Note
  • This parameter takes effect and must be specified only when you set the AutoRenew parameter to true.
  • You cannot query the auto-renewal cycle by calling an API operation. To obtain the auto-renewal cycle, you can perform the following procedure: In the top navigation bar of the ApsaraDB for Redis console, choose Expenses > Renewal Management. On the page that appears, enter the ID of the instance and the -bw suffix in the Instance ID field. Example: r-bp1zxszhcgatnx****-bw.
    •
    		1
    ChargeTypestringYes

    The billing method of the bandwidth instance. Default value: PostPaid. Valid values:

    • PrePaid: subscription
    • PostPaid: pay-as-you-go
    		PostPaid

    Response parameters

    ParameterTypeDescriptionExample
    object
    OrderIdstring

    The ID of the order.

    		2084452111111
    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-06-06The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ChargeType