调用CreateCenBandwidthPackage接口创建带宽包实例。

使用说明

  • 在创建带宽包实例时需要指定互通区域。带宽包的区域是地域的集合,每个区域包含一个或多个阿里云地域,您可以根据要互通的地域来选择带宽包的互通区域。关于区域和地域的关系,请参见购买带宽包
  • 带宽包的计费详情,请参见计费说明
  • CreateCenBandwidthPackage接口属于异步接口,即系统会先返回一个带宽包实例ID,但该带宽包并未创建完成,系统后台的创建任务仍在进行。您可以调用DescribeCenBandwidthPackages接口查询带宽包的状态,当带宽包处于IdleInUse状态时,表示带宽包创建完成。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateCenBandwidthPackage

系统规定参数。取值:CreateCenBandwidthPackage

ClientToken String 02fb3da4-130e-11e9-8e44-001****

客户端Token,用于保证请求的幂等性。

由客户端生成该参数值,需保证该参数在不同请求间唯一,最大值不超过64个ASCII字符。

Name String nametest

带宽包实例的名称。

长度为2~128个字符,必须以大小写字母或中文开头,可包含数字、下划线(_)和短划线(-),但不能以http://https://开头。

Description String namedesc

带宽包实例的描述信息。

Bandwidth Integer 2

带宽包实例的带宽峰值。单位:Mbps。取值范围:2~10000

GeographicRegionAId String China

网络实例所属的区域。取值:

  • China:中国内地。
  • North-America:北美。
  • Asia-Pacific:亚太。
  • Europe:欧洲。
  • Australia:澳洲。
GeographicRegionBId String China

另一个网络实例所属的区域。取值:

  • China:中国内地。
  • North-America:北美。
  • Asia-Pacific:亚太。
  • Europe:欧洲。
  • Australia:澳洲。
BandwidthPackageChargeType String PREPAY

带宽包实例的付费类型。取值: PREPAY,表示先付费后使用的付费方式。

Period Integer 1

带宽包实例的购买时长。默认值:1。

  • PricingCycle取值为Month时,Period取值范围为1~36
  • PricingCycle取值为Year时,Period取值范围为1~3
说明BandwidthPackageChargeTypePREPAY时本参数必填。
PricingCycle String Month

带宽包实例的计费周期。取值:

  • Month(默认值):按月计费。
  • Year:按年计费。
AutoPay Boolean false

是否自动支付带宽包实例的账单。取值:

  • true:是。
  • false(默认值):否。

如果您选择不自动支付账单,在您调用本接口后,请前往控制台的订单中心完成支付,实例才能创建成功。

AutoRenew Boolean false

是否开启自动续费功能。取值:

  • true:是。
  • false(默认值):否。
说明 目前仅预付费带宽包支持自动续费。
AutoRenewDuration Integer 1

自动续费时长。单位:月。取值范围:0~2147483647。默认值:1

返回数据

名称 类型 示例值 描述
CenBandwidthPackageId String cenbwp-4c2zaavbvh5fx****

新建的带宽包实例ID。

CenBandwidthPackageOrderId String 20156420004****

带宽包实例的订单ID。

RequestId String E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateCenBandwidthPackage
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&Name=nametest
&Description=namedesc
&Bandwidth=2
&GeographicRegionAId=China 
&GeographicRegionBId=China 
&BandwidthPackageChargeType=PREPAY
&Period=1
&PricingCycle=Month
&AutoPay=false
&AutoRenew=false
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateCenBandwidthPackageResponse>
    <RequestId>E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B</RequestId>
    <CenBandwidthPackageOrderId>20156420004****</CenBandwidthPackageOrderId>
    <CenBandwidthPackageId> cenbwp-4c2zaavbvh5fx****</CenBandwidthPackageId>
</CreateCenBandwidthPackageResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B",
  "CenBandwidthPackageOrderId" : "20156420004****",
  "CenBandwidthPackageId" : "cenbwp-4c2zaavbvh5fx****"
}

错误码

HttpCode 错误码 错误信息 描述
400 UnSupported.ChargeType The charge type is not supported. 不支持该付费类型。

访问错误中心查看更多错误码。