Adjusts the bandwidth of an ApsaraDB for Redis instance.
Operation description
When you call this operation, make sure that your instance is an ApsaraDB for Redis Community Edition instance or an ApsaraDB for Redis Enhanced Edition (Tair) DRAM-based instance, and that the instance is deployed in classic mode. For more information, see Comparison between cloud-native instances and classic instances.
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.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
kvstore:EnableAdditionalBandwidth | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The ID of the instance. You can call the DescribeInstances operation to query the IDs of instances. | r-bp1zxszhcgatnx**** |
CouponNo | string | No | The coupon ID. | youhuiquan_promotion_option_id_for_blank |
AutoPay | boolean | No | Specifies whether to enable automatic payment. Default value: true. Valid values:
| true |
NodeId | string | No | 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 |
Bandwidth | string | Yes | The amount of bandwidth that you want to purchase. Unit: MB/s. The value of this parameter must be an integer that is greater than or equal to 0. You can set this parameter to a value that is up to two times the default bandwidth that is supported by the instance type. For example, if the default bandwidth that is supported by the instance type is 10 MB/s, you can set this parameter to a value within the range of 0 to 20. Note
| 20 |
OrderTimeLength | string | No | 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 |
SourceBiz | string | No | The source of the operation. 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:
| false |
AutoRenewPeriod | integer | No | 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
-bw suffix in the Instance ID field. Example: r-bp1zxszhcgatnx****-bw. | 1 |
ChargeType | string | Yes | The billing method of the bandwidth instance. Default value: PostPaid. Valid values:
| PostPaid |
Response parameters
Examples
Sample success responses
JSON
format
{
"OrderId": "2084452111111",
"RequestId": "D622714-AEDD-4609-9167-F5DDD3D1****"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||
---|---|---|---|---|---|---|
2023-06-06 | The request parameters of the API has changed | see changesets | ||||
|