tencent cloud

Tencent Cloud Distributed Cache (Redis OSS-Compatible)

ドキュメントTencent Cloud Distributed Cache (Redis OSS-Compatible)API DocumentationOther APIsDescribeInstanceSpecBandwidth

DescribeInstanceSpecBandwidth

Download
フォーカスモード
フォントサイズ
最終更新日: 2026-08-14 16:52:16

1. API Description

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

This API is used to query or calculate bandwidth specifications.

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: DescribeInstanceSpecBandwidth.
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 No String

Specify the instance ID. Log in to the Redis console and copy the instance ID from the instance list. Meanwhile, InstanceId and specification parameters cannot be empty at the same time. Provide at least one.

  • If only InstanceId is specified: Query the bandwidth of the current instance.
  • If InstanceId and at least one specification parameter (ShardSize, ShardNum, or ReplicateNum) are specified: Calculate the bandwidth after specification modification.
  • If partial or all specification parameters (ShardSize, ShardNum, ReplicateNum, and Type) are specified without InstanceId: Query the theoretical bandwidth based on the combined query of specifications.
ShardSize No Integer

Shard size. Unit: MB.
ShardNum No Integer

Number of shards.
ReplicateNum No Integer

Number of replication groups.
ReadOnlyWeight No Integer

Read-only weight. - 100: Enable read-only slave. - 0: Disable read-only slave.
Type No Integer

Instance type, same as Type in CreateInstances.

3. Output Parameters

Parameter Name Type Description
Bandwidth Integer

Basic bandwidth.
ClientLimit Integer

Connection limit.
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 Querying Bandwidth Specifications

This example shows you how to query bandwidth specifications.

Input Example

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

{
    "InstanceId": "crs-xjhsdj****",
    "ShardSize": 0,
    "ShardNum": 0,
    "ReplicateNum": 0,
    "ReadOnlyWeight": 0,
    "Type": 0
}

Output Example

{
    "Response": {
        "Bandwidth": 0,
        "ClientLimit": 0,
        "RequestId": "4297c734-2f56-49d9-9c14-9d092fXXXXXX"
    }
}

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
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
InvalidParameter.PermissionDenied The API has no CAM permissions.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
前の記事へ: SwitchInstanceVip次の記事へ: DescribeBackupDetail

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック