调用CreateCommonBandwidthPackage接口创建共享带宽实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateCommonBandwidthPackage | 系统规定参数。取值:CreateCommonBandwidthPackage。 |
RegionId | String | 是 | cn-hangzhou | 共享带宽所在的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 |
Zone | String | 否 | cn-hangzhou-a | 共享带宽的可用区。 当前参数暂不生效,无需配置。 |
ISP | String | 否 | BGP | 线路类型。取值:
如果您是单线带宽的白名单用户,您还可以选择以下类型:
如果您是杭州金融云用户,该字段必填,取值:BGP_FinanceCloud。 |
Name | String | 否 | test123 | 共享带宽的名称。 长度为2~128个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-)。 |
Description | String | 否 | abc | 共享带宽的描述信息。 长度为2~256个字符,必须以字母或中文开头,但不能以 |
ClientToken | String | 否 | 02fb3da4-130e-11e9-8e44-001**** | 客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。 |
ResourceGroupId | String | 否 | rg-acfmxazdjdhd**** | 资源组ID。 |
Bandwidth | Integer | 是 | 1000 | 共享带宽的带宽峰值。单位:Mbps。 取值范围:1000~5000。 |
Ratio | Integer | 否 | 20 | 共享带宽的保底百分比,仅取值为20。 当InternetChargeType取值PayBy95时需配置此参数。 说明 仅中国站支持该参数。 |
InternetChargeType | String | 否 | 中国站示例值:PayByBandwidth,国际站示例值:PayByTraffic | 共享带宽的计费方式,取值:
|
SecurityProtectionTypes.N | String | 否 | AntiDDoS_Enhanced | 安全防护级别。
当InternetChargeType取值PayBy95时可以配置此参数。 N的取值范围:1~10。目前仅支持添加1个安全防护级别,添加多个可能无法成功调用该接口。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BandwidthPackageId | String | cbwp-bp1vevu8h3ieh**** | 共享带宽实例的ID。 |
RequestId | String | FF39F653-033E-4CD9-9EDF-3CCA5A71FBC3 | 请求ID。 |
ResourceGroupId | String | rg-acfmxazdjdhd**** | 资源组ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateCommonBandwidthPackage
&RegionId=cn-hangzhou
&Zone=cn-hangzhou-a
&ISP=BGP
&Name=test123
&Description=abc
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&ResourceGroupId=rg-acfmxazdjdhd****
&Bandwidth=1000
&Ratio=20
&InternetChargeType=中国站示例值:PayByBandwidth,国际站示例值:PayByTraffic
&SecurityProtectionTypes=["AntiDDoS_Enhanced"]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateCommonBandwidthPackageResponse>
<BandwidthPackageId>cbwp-bp1vevu8h3ieh****</BandwidthPackageId>
<RequestId>FF39F653-033E-4CD9-9EDF-3CCA5A71FBC3</RequestId>
<ResourceGroupId>rg-acfmxazdjdhd****</ResourceGroupId>
</CreateCommonBandwidthPackageResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"BandwidthPackageId" : "cbwp-bp1vevu8h3ieh****",
"RequestId" : "FF39F653-033E-4CD9-9EDF-3CCA5A71FBC3",
"ResourceGroupId" : "rg-acfmxazdjdhd****"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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 | InvalidResourceGroupId | The specified ResourceGroupId does not exist. | 资源组ID不存在。 |
400 | OperationFailed.SyncOrderToSub | SyncOrderToSub error. | 操作失败 |
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. | 该可用区不存在。 |
访问错误中心查看更多错误码。