1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(SetCcnRegionBandwidthLimits)用于设置云联网(CCN)各地域出带宽上限,或者地域间带宽上限。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SetCcnRegionBandwidthLimits。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
CcnId | 是 | String | CCN实例ID,形如:ccn-f49l6u0z。 示例值:ccn-f49l6u0z |
CcnRegionBandwidthLimits.N | 是 | Array of CcnRegionBandwidthLimit | 云联网(CCN)各地域出带宽上限。 |
SetDefaultLimitFlag | 否 | Boolean | 是否恢复云联网地域出口/地域间带宽限速为默认值(1Gbps)。false表示不恢复;true表示恢复。恢复默认值后,限速实例将不在控制台展示。该参数默认为 false,不恢复。 示例值:true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设置云联网地域间带宽上限
设置云联网地域间带宽上限,需要传递源和目的端地域,如果设置的是源或者目的地域为黑石地域,需要传递IsBm或者DstIsBm为true。例如在示例中,设置ap-guangzhou到ap-shanghai黑石的地域间上限为1000Mbps,设置ap-guangzhou到ap-beijing的地域间上限为500Mbps。
输入示例
https://vpc.tencentcloudapi.com/?Action=SetCcnRegionBandwidthLimits
&CcnId=ccn-gree226l
&CcnRegionBandwidthLimits.0.Region=ap-guangzhou
&CcnRegionBandwidthLimits.0.BandwidthLimit=1000
&CcnRegionBandwidthLimits.0.DstRegion=ap-shanghai
&CcnRegionBandwidthLimits.0.DstIsBm=true
&CcnRegionBandwidthLimits.1.Region=ap-guangzhou
&CcnRegionBandwidthLimits.1.BandwidthLimit=500
&CcnRegionBandwidthLimits.1.DstRegion=ap-beijing
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "9c53ff69-1bb6-4c89-adbb-812233a85acc"
}
}
示例2 设置云联网各地域出带宽上限
设置云联网各地域出带宽上限。例如在示例中,设置ap-guangzhou,ap-shanghai地域的出带宽上限分别为1000Mbps,500Mbps。
输入示例
https://vpc.tencentcloudapi.com/?Action=SetCcnRegionBandwidthLimits
&CcnId=ccn-gree226l
&CcnRegionBandwidthLimits.0.Region=ap-guangzhou
&CcnRegionBandwidthLimits.0.BandwidthLimit=1000
&CcnRegionBandwidthLimits.1.Region=ap-shanghai
&CcnRegionBandwidthLimits.1.BandwidthLimit=500
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "9c53ff69-1bb6-4c89-adbb-812233a85acc"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.NotPostpaidCcnOperation | 当前云联网为非后付费类型,无法进行此操作。 |