All Products
Search
Document Center

:ModifyInstanceBandwidth

Last Updated:Dec 19, 2024

Sets the intended bandwidth value of a Tair (Redis OSS-compatible) instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:ModifyInstanceBandwidthupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance. You can call the DescribeInstances operation to query the ID of the instance.

r-bp1zxszhcgatnx****
TargetIntranetBandwidthstringYes

The total expected bandwidth of the instance.

Note If the instance is a cluster instance, the TargetIntranetBandwidth must be divisible by the number of shards in the instance. This operation is not supported for read/write splitting instances.
260

Response parameters

ParameterTypeDescriptionExample
object
OrderIdstring

The ID of the order.

236934422960904
RequestIdstring

The ID of the request.

5D622714-AEDD-4609-9167-F5DDD3D1****

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.