调用CreateCommonBandwidthPackage接口创建共享带宽实例。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:CreateCommonBandwidthPackage | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 共享带宽所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
Zone | string | 否 | 共享带宽的可用区。 创建云盒共享带宽时,该参数必填。 | ap-southeast-1-lzdvn-cb |
ISP | string | 否 | 线路类型。取值:
如果您是单线带宽的白名单用户,您还可以选择以下类型:
如果您是杭州金融云用户,该字段必填,取值:BGP_FinanceCloud。 | BGP |
Name | string | 否 | 共享带宽的名称。 长度为 0-128 个字符,不能以 | test123 |
Description | string | 否 | 共享带宽的描述信息。 长度为 0-256 个字符,不能以 | abc |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 02fb3da4-130e-11e9-8e44-001**** |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-acfmxazdjdhd**** |
Bandwidth | integer | 是 | 共享带宽的带宽峰值。单位:Mbps。 | 1000 |
Ratio | integer | 否 | 共享带宽的保底百分比,仅取值为 20。 说明
仅中国站支持该参数。
| 20 |
InternetChargeType | string | 否 | 共享带宽的计费方式,取值: PayByTraffic(按流量计费)。 | 中国站示例值:PayByBandwidth,国际站示例值:PayByTraffic |
SecurityProtectionTypes | array | 否 | 安全防护级别。
最大支持添加 10 个安全防护级别。 说明
该参数已废弃。
| |
string | 否 | 安全防护级别。
N 的取值范围:1~10。目前仅支持添加 1 个安全防护级别,添加多个可能无法成功调用该接口。 说明
该参数已废弃。
| AntiDDoS_Enhanced |
返回参数
示例
正常返回示例
JSON
格式
{
"BandwidthPackageId": "cbwp-bp1vevu8h3ieh****",
"RequestId": "FF39F653-033E-4CD9-9EDF-3CCA5A71FBC3",
"ResourceGroupId": "rg-acfmxazdjdhd****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ResourceNotEnough.Bandwidth | The specified resource of Bandwidth is not enough. | 带宽资源不足 |
400 | MissingParameter | Miss mandatory parameter. | 缺少必要参数,请您检查必填参数是否都已填后再进行操作。 |
400 | InvalidParameter.Name.Malformed | The specified Name is not valid. | 该名称不合法,请您按照正确的格式书写名称。 |
400 | InvalidParameter.Description.Malformed | The specified Description is not valid. | 该描述不合法。 |
400 | BandwidthPackageOperation.conflict | BandwidthPackage operation conflict, please wait a moment and try again. | - |
400 | InvalidParameter.Bandwidth | The specified bandwidth is not valid. | - |
400 | BandwidthPackage.QuotaExceeded | Create BandwidthPackage has exceeded quota. | - |
400 | IllegalParam.Zone | Zone is illegal. | - |
400 | InvalidParameter.InvalidChargeType | The specified chargeType is not valid. | - |
400 | InvalidResourceGroupId | The specified ResourceGroupId does not exist. | 资源组ID不存在。 |
400 | OperationFailed.SaleValidate | Validate sale condition with subArticle failed. | 使用子项目验证销售条件失败。 |
400 | OperationFailed.SyncOrderToSub | SyncOrderToSub error. | 操作失败 |
400 | IllegalParam.Ratio | The specified ratio is not valid. | - |
400 | OperationUnsupported.InvalidZone | It is not allowed to create CBWP in the specified zone. | - |
400 | IllegalParam.AvailableZone | %s | - |
400 | MissingParam.NameOrDescription | %s | - |
400 | OperationFailed.SystemBusy | Operation failed because system is busy. | 系统繁忙,请稍后重试 |
400 | UnsupportedRegion.CloudBoxInternet | The region does not support cloud box public network. | 该地域不支持云盒公网。 |
400 | ResourceNotEnough.CommonBandWidthPackage | The specified resource commonBandWidthPackage is not enough. | 共享带宽包资源不足。 |
404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
404 | InvalidVpcId.NotFound | Specified value of VpcId is not found in our record. | 该VPC不存在,请您检查输入的VPC是否正确。 |
404 | InvalidZoneId.NotFound | Specified value of ZoneId is not exists. | 该可用区不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-02-23 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-11-06 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
2023-06-26 | OpenAPI 错误码发生变更 | 查看变更详情 |