Docs

Cache for Redis

Connection management

DescribeDBInstanceBandwidthPerShard

Call the DescribeDBInstanceBandwidthPerShard API to query the single-shard bandwidth details of the target Redis, including default bandwidth and additional bandwidth.

Request type

Synchronous request.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameters	Type	Required	Example	Description
InstanceId	String	Yes	redis-cn0212gzmh2xsh2xs	Instance ID. tip You can call the DescribeDBInstances API to query the basic information of all Redis instances in the target region, including the instance ID.

Response parameters

Parameters	Type	Example	Description
DefaultBandwidthPerShard	Integer	48	Default bandwidth for a single shard in an instance. Both read bandwidth (i.e., downstream bandwidth) and write bandwidth (i.e., upstream bandwidth) are this value. Unit: MB/s. The default bandwidth varies depending on the instance's node specifications. For more information, refer to Instance Specifications.
AdditionalBandwidthPerShard	Integer	20	This field is deprecated and no longer used. Disregard it.
AdditionalWriteBandwidthPerShard	Integer	20	Extra write bandwidth for a single shard, which is the additional write bandwidth required beyond the default bandwidth. Unit: MB/s. tip If the value is 0, no additional write bandwidth is configured for the current instance.
AdditionalReadBandwidthPerShard	Integer	20	Additional read bandwidth per shard, which is added on top of the default bandwidth. Unit: MB/s. tip When this value is 0, it indicates that no additional read bandwidth is set for the current instance.

Example

Request example

Response example

Error code

For more details, see Error code.

Last updated: 2026.09.21 15:01:11