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

This operation adjusts the bandwidth for an ApsaraDB for Redis instance that uses the pay-as-you-go billing method. You need to specify only the InstanceId, NodeId (optional), Bandwidth, and ChargeType parameters.

Operation description

If auto scaling of bandwidth is enabled when you call this operation, the auto scaling feature takes precedence. When the bandwidth scales back, it reverts to the default bandwidth of the instance type. For more information about the feature's limitations, billing details, and FAQ, see Adjust instance bandwidth.

Note

Before you call this operation, you can call the DescribeRoleZoneInfo operation to query the current bandwidth for each data node of 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 the DescribeInstances operation to query the instance ID.	r-bp1zxszhcgatnx****
CouponNo	string	No	The coupon ID.	youhuiquan_promotion_option_id_for_blank
AutoPay	boolean	No	Specifies whether to enable auto-payment. Valid values: true: Enables auto-payment. This is the default. Ensure that your account has a sufficient balance. false: Disables auto-payment. You must manually complete the payment.	true
NodeId	string	No	The ID of the data shard. You can call the DescribeLogicInstanceTopology operation to query data shard IDs. Separate multiple data shard IDs with commas (,). You can also set this parameter to All to specify all data shards. Note This parameter is required only when the instance uses the cluster architecture or the read/write splitting architecture.	r-bp1zxszhcgatnx****-db-0
Bandwidth	string	No	The amount of bandwidth to add, 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 type or a single data shard, with an upper limit of 192 MB/s. For example, if the default bandwidth of an instance is 10 MB/s, the valid values for this parameter are 0 to 60. Note You can call the DescribeRoleZoneInfo operation and check the value of the DefaultBandWidth parameter in the response to get the default maximum bandwidth. For more information about instance types, see Instance types. If you specified multiple data shard IDs for the NodeId parameter, the bandwidth values that you specify for this parameter must correspond to the order of the data shard IDs. Separate multiple bandwidth values with commas (,).	20
OrderTimeLength	string	No	The subscription duration, 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, you must call the RenewAdditionalBandwidth operation to renew the bandwidth before it expires.	30
SourceBiz	string	No	The source of the call. This parameter is used for internal maintenance. Do not specify it.	SDK
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true: Enables auto-renewal. false: Disables auto-renewal. This is the default.	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 required only when AutoRenew is set to true. After you set this parameter, you cannot query its value by calling API operations. To check this setting, go to the console. In the top navigation bar, choose Billing > Renewal Management. Then, in the Instance ID field, enter the instance ID followed by the `-bw` suffix (for example, r-bp1zxszhcgatnx****-bw).	1
ChargeType	string	No	The billing method for the additional bandwidth. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go. This is the only supported billing method.	PrePaid
BandWidthBurst	boolean	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
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.