tencent cloud

APIs

DokumentasiAPIsTencent Cloud Distributed Cache (Redis OSS-Compatible)Instance APIsDescribeBandwidthRange

DescribeBandwidthRange

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-08-14 16:53:12

1. API Description

Domain name for API request: redis.intl.tencentcloudapi.com.

This API is used to query the information of instance bandwidth.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeBandwidthRange.
Version Yes String Common Params. The value used for this API: 2018-04-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String

Instance ID. Log in to the Redis console and copy it from the instance list.

3. Output Parameters

Parameter Name Type Description
BaseBandwidth Integer

Standard bandwidth. The bandwidth allocated by the system to each node when purchasing instances.

Measurement unit: MB/s.
AddBandwidth Integer

Refers to the additional bandwidth of the instance. When the standard bandwidth cannot meet needs, users can manually add bandwidth.

  • When read-only replicas are enabled, total instance bandwidth = additional bandwidth * shard quantity + standard bandwidth * shard quantity * Max ([number of read-only replicas, 1]). Shard quantity in standard architecture = 1.
  • When read-only replicas are not enabled, total instance bandwidth = additional bandwidth * shard quantity + standard bandwidth * shard quantity. Shard quantity in standard architecture = 1.
Unit: MB/s.
MinAddBandwidth Integer

Minimum set for additional bandwidth.

Unit: MB/s.
MaxAddBandwidth Integer

Set upper limit for additional bandwidth.

Measurement unit: MB/s.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Request Example

Input Example

POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBandwidthRange
<Common request parameters>

{
    "InstanceId": "crs-sa5****"
}

Output Example

{
    "Response": {
        "MinAddBandwidth": 0,
        "MaxAddBandwidth": 0,
        "BaseBandwidth": 0,
        "AddBandwidth": 0,
        "RequestId": "5e4ebf65-7ac6-42a2-de84-8fa5c00dd9a2"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM signature/authentication error.
AuthFailure.InvalidAuthorization Invalid authorization.
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
FailedOperation.UnSupportError The instance does not support this API.
InternalError Internal error.
InvalidParameter.IllegalParameterError Invalid parameter.
InvalidParameter.InvalidParameter Invalid service parameter.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
Topik sebelumnya: DescribeAutoBackupConfigTopik selanjutnya: DescribeInstanceAccount

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan