Scale Tair Instance Bandwidth via ModifyInstanceBandwidth API - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

Before you call this operation, familiarize yourself with the billing methods and pricing of instance bandwidth. Tair (Redis OSS-compatible) charges hourly fees based on the amount and duration of the extra bandwidth that you purchase. Fees vary by region. For more information, see Billable items.
The bandwidth of an instance or shard can be increased by up to six times its default bandwidth, with a maximum increase of 192 Mbit/s. For example, if the default bandwidth of a Tair DRAM-based master-replica instance with 2 GB of memory is 96 Mbit/s, you can increase it by up to 192 Mbit/s for a maximum of 288 Mbit/s. If the default bandwidth of a Redis Open-Source Edition master-replica instance with 256 MB of memory is 10 Mbit/s, you can increase it by up to 60 Mbit/s for a maximum of 70 Mbit/s.

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:ModifyInstanceBandwidth

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. You can call DescribeInstances to query the instance ID.	r-bp1zxszhcgatnx****
TargetIntranetBandwidth	string	Yes	The expected total bandwidth of the instance. Note For cluster instances, TargetIntranetBandwidth must be divisible by the number of shards. This operation is not supported for read/write splitting instances.	260

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.