1. 接口描述
接口请求域名: redis.tencentcloudapi.com 。
本接口(DescribeInstanceSpecBandwidth)用于查询或计算带宽规格。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeInstanceSpecBandwidth。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-12。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 否 | String | 指定实例 ID。例如:crs-xjhsdj。请登录Redis控制台在实例列表复制实例 ID。填写实例id或者规格,两者必选其一。 示例值:crs-xjhsdj |
| ShardSize | 否 | Integer | 分片大小,单位:MB 示例值:4096 |
| ShardNum | 否 | Integer | 分片数量。 示例值:1 |
| ReplicateNum | 否 | Integer | 复制组数量。 示例值:1 |
| ReadOnlyWeight | 否 | Integer | 只读权重。 - 100:开启从只读。 - 0:关闭从只读。 示例值:0 |
| Type | 否 | Integer | 实例类型,同 CreateInstances 的Type。 示例值:2 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Bandwidth | Integer | 基础带宽。 示例值:16777216 |
| ClientLimit | Integer | 链接限制。 示例值:10000 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询带宽规格
查询带宽规格
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceSpecBandwidth
<公共请求参数>
{
"InstanceId": "crs-xjhsdj****",
"ShardSize": 0,
"ShardNum": 0,
"ReplicateNum": 0,
"ReadOnlyWeight": 0,
"Type": 0
}
输出示例
{
"Response": {
"Bandwidth": 0,
"ClientLimit": 0,
"RequestId": "4297c734-2f56-49d9-9c14-9d092fXXXXXX"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.SystemError | 内部系统错误,和业务无关。 |
| InternalError.DbOperationFailed | 统一的 DB 操作错误,可以是 update insert select..。 |
| InvalidParameter.PermissionDenied | 接口没有cam权限。 |
| UnauthorizedOperation.NoCAMAuthed | 无cam 权限。 |