Use EnableAdditionalBandwidth to adjust instance bandwidth - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Adjusts the bandwidth of a Tair (Redis® OSS-Compatible) instance. Currently, only the pay-as-you-go billing method is supported. You only need to specify the InstanceId, NodeId (optional), Bandwidth, and ChargeType parameters.

Operation description

If you call this operation while the automatic bandwidth adjustment feature is enabled for the instance, the instance preferentially uses the automatic bandwidth adjustment feature. When the bandwidth is automatically downgraded, it is downgraded to the default bandwidth of the instance specification. For more information about the limits, billing, and FAQ of this feature, see Modify instance bandwidth.

Note

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:EnableAdditionalBandwidth

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. You can call DescribeInstances to query the instance ID.	r-bp1zxszhcgatnx****
CouponNo	string	No	The coupon code.	youhuiquan_promotion_option_id_for_blank
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: true (default): Automatic payment is enabled. Make sure that your account has sufficient balance. false: Automatic payment is disabled. You must manually complete the payment.	true
NodeId	string	No	The ID of the data shard. You can call DescribeLogicInstanceTopology to query the data shard ID. Separate multiple IDs with commas (,). You can also set this parameter to All to specify all data shards. Note This parameter is available and required only when the instance uses the cluster architecture or read/write splitting architecture.	r-bp1zxszhcgatnx****-db-0
Bandwidth	string	No	The amount of bandwidth to increase, in MB/s. The value must be an integer greater than or equal to 0. The maximum value is six times the default bandwidth of the instance or a single shard, with an upper limit of 192 MB/s. For example, if the default bandwidth of the instance is 10 MB/s, the valid range is 0 to 60. Note You can call DescribeRoleZoneInfo and check the DefaultBandWidth response parameter to obtain the default maximum bandwidth. For more information about instance specifications, see Instance specification navigation. If you specify multiple data shard IDs for the request parameter NodeId, the bandwidth values specified for this parameter must correspond to the data shard IDs in order. Separate multiple bandwidth values with commas (,).	20
OrderTimeLength	string	No	The duration of the purchase, in days. Valid values: 1, 2, 3, 7, 14, 30, 60, 90, 180, 365, 730, 1095, and 1825. Note To continue using the purchased bandwidth, call RenewAdditionalBandwidth to renew the bandwidth before it expires.	30
SourceBiz	string	No	The source of the request. This parameter is used only for internal maintenance. You do not need to specify this parameter.	SDK
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true: Auto-renewal is enabled. false (default): Auto-renewal is disabled.	false
AutoRenewPeriod	integer	No	The auto-renewal period, in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, and 60. Note This parameter is available and required only when the AutoRenew parameter is set to true. After this parameter is set, you cannot query the value by calling an API operation. In the console, click Expenses and Costs > Renewal Management from the top menu bar, and then enter the instance ID followed by the `-bw` suffix (for example, r-bp1zxszhcgatnx**-bw) in the Instance ID** text box to query the value.	1
ChargeType	string	No	The billing method for the additional bandwidth. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go. Currently, only this method is supported.	PrePaid
BandWidthBurst	boolean	No	Specifies whether to enable burstable (second-level) elastic bandwidth. After elastic bandwidth scaling is enabled, burstable (second-level) elastic bandwidth cannot be enabled, and vice versa.	false

Response elements

Element	Type	Description	Example
	object
OrderId	string	The order ID.	2084452111111
RequestId	string	The request ID.	D622714-AEDD-4609-9167-F5DDD3D1****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.