tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for Redis®Instance APIsDescribeBandwidthRange
DescribeBandwidthRange
Last updated: 2024-12-04 11:19:27
DescribeBandwidthRange
Last updated: 2024-12-04 11:19:27

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 in the instance list.

3. Output Parameters

Parameter Name Type Description
BaseBandwidth Integer Standard bandwidth, which is the bandwidth allocated by the system to each node when an instance is purchased.
AddBandwidth Integer The additional bandwidth of the instance. If the standard bandwidth does not meet your needs, you can increase the bandwidth on your own.
  • If read-only replica is enabled, the total instance bandwidth = additional bandwidth * shard quantity + standard bandwidth * shard quantity * Max ([read-only replica quantity, 1]). The shard quantity in the standard architecture is 1.
  • If read-only replica is not enabled, the total instance bandwidth = additional bandwidth * shard quantity + standard bandwidth * shard quantity. The shard quantity in the standard architecture is 1.
MinAddBandwidth Integer The lower limit for additional bandwidth
MaxAddBandwidth Integer The upper limit for additional bandwidth
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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon