调用CreateCenBandwidthPackage接口创建带宽包实例。
使用说明
在创建带宽包实例时需要指定互通区域。带宽包的区域是地域的集合,每个区域包含一个或多个阿里云地域,您可以根据要互通的地域来选择带宽包的互通区域。关于区域和地域的关系,请参见购买带宽包。
带宽包按照计费方式不同,分为预付费带宽包和后付费带宽包,关于两种带宽包的计费详情,请参见计费说明。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 否 | CreateCenBandwidthPackage | 要执行的操作,取值:CreateCenBandwidthPackage。 |
| Bandwidth | Integer | 是 | 2 | 带宽包实例的带宽峰值,单位为Mbps,最小值为2。 取值范围:2~10000。 |
| GeographicRegionAId | String | 是 | China | 网络实例所属的区域,取值:
|
| GeographicRegionBId | String | 是 | China | 另一个网络实例所属的区域,取值:
|
| ClientToken | String | 否 | 02fb3da4-130e-11e9-8e44-001**** | 客户端Token,用于保证请求的幂等性。 由客户端生成该参数值,需保证该参数在不同请求间唯一,最大值不超过64个ASCII字符。 |
| Name | String | 否 | nametest | 带宽包实例的名称。 长度为2~128个字符,必须以大小写字母或中文开头,可包含数字、下划线(_)和短划线(-),但不能以 |
| Description | String | 否 | namedesc | 带宽包实例的描述信息。 |
| BandwidthPackageChargeType | String | 否 | POSTPAY | 带宽包实例的付费类型,取值:
|
| Period | Integer | 否 | 1 | 带宽包实例的购买时长。默认值:1。
说明 当
BandwidthPackageChargeType为
PREPAY时本参数必填。
|
| PricingCycle | String | 否 | Month | 带宽包实例的计费周期,取值:
|
| AutoPay | Boolean | 否 | true | 是否自动支付带宽包实例的账单,取值:
如果您选择不自动支付账单,在您调用本接口后,请前往控制台的订单中心完成支付,实例才能创建成功。 |
| AutoRenew | Boolean | 否 | true | 是否开启自动续费功能。取值:
说明 目前仅预付费带宽包支持自动续费。
|
| AutoRenewDuration | Integer | 否 | 1 | 自动续费时长。默认值:1。单位:月。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| CenBandwidthPackageId | String | cenbwp-4c2zaavbvh5fx**** | 新建的带宽包实例ID。 |
| CenBandwidthPackageOrderId | String | 20156420004**** | 带宽包实例的订单ID。 |
| RequestId | String | E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B | 请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateCenBandwidthPackage &Bandwidth=2 &GeographicRegionAId=China &GeographicRegionBId=China &<公共请求参数>
正常返回示例
XML格式
<CreateCenBandwidthPackageResponse>
<RequestId>E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B</RequestId>
<CenBandwidthPackageOrderId>20156420004****</CenBandwidthPackageOrderId>
<CenBandwidthPackageId> cenbwp-4c2zaavbvh5fx****</CenBandwidthPackageId>
</CreateCenBandwidthPackageResponse>
JSON格式
{
"RequestId": "E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B",
"CenBandwidthPackageOrderId": "20156420004****",
"CenBandwidthPackageId": "cenbwp-4c2zaavbvh5fx****"
}
错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | UnSupported.ChargeType | The charge type is not supported. | 不支持该付费类型。 |
访问错误中心查看更多错误码。