Call the RenewAdditionalBandwidth API - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

To adjust instance bandwidth, use the Tair (Redis OSS-compatible) console. For more information, see Adjust the bandwidth of an instance. Alternatively, call the EnableAdditionalBandwidth operation to purchase bandwidth for an 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:RenewAdditionalBandwidth

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 instance IDs.	r-bp1zxszhcgatnx****
CouponNo	string	No	The ID of the coupon.	youhuiquan_promotion_option_id_for_blank
AutoPay	boolean	No	Whether to enable automatic payment. Default value: true. Valid values: true: enables automatic payment. false: disables automatic payment. If automatic payment is disabled, you must perform the following steps to complete the payment in the Tair (Redis OSS-compatible) 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
OrderTimeLength	string	Yes	The validity period of the purchased bandwidth. Unit: days. Valid values: 1, 2, 3, 7, 14, 30, 60, 90, 180, 365, 730, 1095, and 1825.	30
SourceBiz	string	No	The source of the operation. Internal use only. You do not need to specify this parameter.	SDK

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.