Modify internal bandwidth for dedicated clusters using ModifyIntranetAttribute - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

Note

This operation applies only to instances deployed in a dedicated cluster. To adjust the bandwidth of a standard instance, call the EnableAdditionalBandwidth operation.

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

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	r-bp1zxszhcgatnx****
BandWidth	integer	No	The bandwidth to add. Unit: Mbit/s. The value must be an integer greater than or equal to 0. In most cases, you can add up to two times the default maximum bandwidth of the current instance type. For more information about the bandwidth specifications supported by different instance types, see Overview. The bandwidth is also subject to the following limits: The bandwidth of an individual instance cannot exceed 75% of the host bandwidth. For more information about host specifications and bandwidth, see Instance types of hosts. The total bandwidth of all instances on the host cannot exceed 150% of the host bandwidth. You can configure resource overcommitment to handle traffic spikes. For more information, see Configure resource overcommitment to reduce costs. Note If you do not specify this parameter for a standard instance, the bandwidth is set to two times the current bandwidth.	10
NodeId	string	No	The ID of the data node. Call the DescribeClusterMemberInfo operation to query the node ID. Separate multiple IDs with commas (,). Note This parameter is required if the instance is a cluster instance.	r-bp1zxszhcgatnx****-db-0

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	97AC8948-D7E4-457E-BE03-850CF04E****

Examples

Success response

JSON format

{
  "RequestId": "97AC8948-D7E4-457E-BE03-850CF04E****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.