1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口 (DescribeInstanceInternetBandwidthConfigs) 用于查询实例带宽配置。
- 只支持查询
BANDWIDTH_PREPAID
( 预付费按带宽结算 )计费模式的带宽配置。 - 接口返回实例的所有带宽配置信息(包含历史的带宽配置信息)。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeInstanceInternetBandwidthConfigs。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 待操作的实例ID。可通过 DescribeInstances 接口返回值中的InstanceId 获取。示例值:ins-6lafsaz0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
InternetBandwidthConfigSet | Array of InternetBandwidthConfig | 带宽配置信息列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例带宽配置
输入示例
GET https://cvm.tencentcloudapi.com/?Action=DescribeInstanceInternetBandwidthConfigs
&InstanceId=ins-6lafsaz0
&<公共请求参数>
输出示例
{
"Response": {
"InternetBandwidthConfigSet": [
{
"StartTime": "2017-03-12T16:00:00Z",
"EndTime": "2017-04-12T16:00:00Z",
"InternetAccessible": {
"InternetMaxBandwidthOut": 50,
"InternetChargeType": "BANDWIDTH_PREPAID"
}
}
],
"RequestId": "314161cd-ee40-4c37-921e-b10c4ed5607c"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.NotFoundEIP | 当前实例没有弹性IP |
InternalServerError | 操作内部错误。 |
InvalidInstance.NotSupported | 不被支持的实例。 |
InvalidInstanceId.Malformed | 无效实例ID 。指定的实例ID 格式错误。例如实例ID 长度错误ins-1122 。 |
InvalidInstanceId.NotFound | 没有找到相应实例。 |
InvalidParameterValue.InstanceIdMalformed | 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。 |
InvalidParameterValue.InvalidAppIdFormat | 无效的appid。 |
MissingParameter | 缺少参数错误。 |