查询实例带宽信息

最近更新时间:2024-08-21 02:04:27

我的收藏

1. 接口描述

接口请求域名: redis.tencentcloudapi.com 。

本接口(DescribeBandwidthRange)用于查询实例带宽信息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBandwidthRange。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID。
示例值:crs-xxx

3. 输出参数

参数名称 类型 描述
BaseBandwidth Integer 标准带宽。指购买实例时,系统为每个节点分配的带宽。
示例值:1
AddBandwidth Integer 指实例的附加带宽。标准带宽不满足需求的情况下,用户可自行增加的带宽。
  • 开启副本只读时,实例总带宽 = 附加带宽 * 分片数 + 标准带宽 * 分片数 * Max ([只读副本数量, 1]),标准架构的分片数 = 1。
  • 没有开启副本只读时,实例总带宽 = 附加带宽 * 分片数 + 标准带宽 * 分片数,标准架构的分片数 = 1。

示例值:1
MinAddBandwidth Integer 附加带宽设置下限。
示例值:1
MaxAddBandwidth Integer 附加带宽设置上限。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBandwidthRange
<公共请求参数>

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.InvalidAuthorization 认证无效。
FailedOperation.SystemError 内部系统错误,和业务无关。
FailedOperation.UnSupportError 实例不支持该接口。
InternalError 内部错误。
InvalidParameter.IllegalParameterError 非法参数错误。
InvalidParameter.InvalidParameter 业务参数错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound.InstanceNotExists 根据 serialId 没有找到对应 redis。