调用CreateBandwidthPackage接口创建带宽包。

使用说明

使用全球加速GA(Global Accelerator)服务实现网络加速,您需要创建基础带宽包。基础带宽包支持以下带宽类型:

  • 标准加速带宽:默认的加速区域和服务区域都位于中国内地,被加速的服务部署在阿里云上。
  • 增强加速带宽:默认的加速区域和服务区域都位于中国内地,可同时加速阿里云和非阿里云的公网服务。
  • 精品加速带宽:默认的加速区域和服务区域都位于海外,可同时加速阿里云和非阿里云的公网服务。如果要实现中国内地用户的网络加速,需选择中国香港作为加速地域。

调用本接口时,请注意以下事项:

  • CreateBandwidthPackage接口属于异步接口,即系统会先返回一个带宽包ID,但带宽包并未创建完成,系统后台的创建任务仍在进行。您可以调用DescribeBandwidthPackage查询带宽包的状态:
    • 当带宽包处于init状态时,表示带宽包正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
    • 当带宽包处于active状态时,表示带宽包创建完成。
  • CreateBandwidthPackage接口不支持在同一个全球加速实例内并发创建带宽包。

调试

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

请求参数

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

系统规定参数,取值:CreateBandwidthPackage

RegionId String cn-hangzhou

全球加速实例所在的地域ID,仅取值cn-hangzhou

Bandwidth Integer 2

带宽包的带宽值。单位:Mbps。

取值范围:2~2000

Duration String 1

购买时长。

  • PricingCycle取值Month时,Duration取值范围为1~9
  • PricingCycle取值Year时,Duration取值范围为1~3

ChargeType取值为PREPAY时,该项不能为空。

PricingCycle String Month

计费周期。取值:

  • Month:按月计费。
  • Year:按年计费。

ChargeType取值为PREPAY时,该项不能为空。

AutoPay Boolean false

是否自动付费。取值:

  • false(默认值):不开启自动付费,生成订单后需要到订单中心完成支付。
  • true:开启自动付费,自动支付订单。
ClientToken String 123e4567****

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

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
Type String Basic

带宽包的类型。取值:

  • Basic:基础带宽包。
  • CrossDomain:跨地域加速包。

中国站仅支持Basic

BandwidthType String Basic

带宽类型。取值:

  • Basic:标准加速带宽。
  • Enhanced:增强加速带宽。
  • Advanced:精品加速带宽。

在带宽包类型Type取值为Basic时,该项不能为空。

AutoUseCoupon String false

是否使用优惠券自动支付账单。取值:

  • true:是。
  • false(默认值):否。
说明AutoPaytrue时,该项才生效。
Ratio Integer 30

95计费保底比例。取值范围:30~100

说明BillingTypePayBY95时,该项才生效。
BillingType String PayByTraffic

后付费计费方式。取值:

  • PayByTraffic(默认值):流量计费。
  • PayBY95:95计费。

按95计费白名单开放,如需使用,请提交工单

ChargeType String PREPAY

付费类型。取值:

  • PREPAY(默认值):预付费,即包年包月。
  • POSTPAY:后付费,即按量付费。

后付费类型白名单开放,如需使用,请提交工单

CbnGeographicRegionIdA String China-mainland

跨地域加速包的互通区域A,仅取值为China-mainland(中国内地)。

仅国际站支持传入该参数。

CbnGeographicRegionIdB String Global

跨地域加速包的互通区域B,仅取值为Global(全球)。

仅国际站支持传入该参数。

AutoRenew Boolean false

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

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

自动续费时长。单位:月。

取值范围:1~12。默认值:1

说明AutoRenewtrue时,该项才生效。

返回数据

名称 类型 示例值 描述
RequestId String 4B6DBBB0-2D01-4C6A-A384-4129266E6B78

请求ID。

BandwidthPackageId String gbwp-bp1sgzldyj6b4q7cx****

带宽包ID。

OrderId String 208257****

订单ID。

如果您未自动支付账单,请您前往订单中心完成支付。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateBandwidthPackage
&RegionId=cn-hangzhou
&Bandwidth=2
&Duration=1
&PricingCycle=Month
&AutoPay=false
&ClientToken=123e4567****
&Type=Basic
&BandwidthType=Basic
&AutoUseCoupon=false
&Ratio=30
&BillingType=PayByTraffic
&ChargeType=PREPAY
&CbnGeographicRegionIdA=China-mainland
&CbnGeographicRegionIdB=Global
&AutoRenew=false
&AutoRenewDuration=1
&公共请求参数

正常返回示例

XML格式

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

<CreateBandwidthPackageResponse>
    <RequestId>4B6DBBB0-2D01-4C6A-A384-4129266E6B78</RequestId>
    <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>
    <OrderId>208257****</OrderId>
</CreateBandwidthPackageResponse>

JSON格式

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

{
  "RequestId" : "4B6DBBB0-2D01-4C6A-A384-4129266E6B78",
  "BandwidthPackageId" : "gbwp-bp1sgzldyj6b4q7cx****",
  "OrderId" : "208257****"
}

错误码

HttpCode 错误码 错误信息 描述
400 MissingParameter.BandwidthType You must specify BandwidthType. 入参缺少参数BandwidthType

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