文档

CreateBandwidthPackage - 创建指定带宽包

更新时间:

调用CreateBandwidthPackage接口创建指定的带宽包。

接口说明

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

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

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

  • CreateBandwidthPackage 接口属于异步接口,即系统会先返回一个带宽包 ID,但带宽包并未创建完成,系统后台的创建任务仍在进行。您可以调用 DescribeBandwidthPackage 查询带宽包的状态:

    • 当带宽包处于 init 状态时,表示带宽包正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
    • 当带宽包处于 active 状态时,表示带宽包创建完成。
  • CreateBandwidthPackage 接口不支持在同一个全球加速实例内并发创建带宽包。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ga:CreateBandwidthPackageWRITE
  • BandwidthPackage
    acs:ga:{#regionId}:{#accountId}:bandwidthpackage/*
  • ga:BandwidthPackageType

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
Bandwidthinteger

带宽包的带宽值。单位:Mbps。 取值范围:2~2000

2
Durationstring

购买时长。

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

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

1
PricingCyclestring

计费周期。取值:

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

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

Month
AutoPayboolean

是否自动付费。取值:

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

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567****
Typestring

带宽包的类型。取值:

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

中国站仅支持 Basic

Basic
BandwidthTypestring

带宽类型。取值:

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

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

Basic
AutoUseCouponstring

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

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

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

说明 BillingTypePayBY95 时,该项才生效。
30
BillingTypestring

后付费计费方式。取值:

  • PayByTraffic(默认值):流量计费。
  • PayBY95:95 计费。按 95 计费方式默认不开放,如需使用,请联系您的商务经理申请。
说明 ChargeTypePOSTPAY 时,该项才生效。
PayByTraffic
ChargeTypestring

付费类型。取值:

  • PREPAY(默认值):预付费,即包年包月。
  • POSTPAY:后付费,即按量付费。后付费类型默认不开放,如需使用,请联系您的商务经理申请。
PREPAY
CbnGeographicRegionIdAstring

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

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

China-mainland
CbnGeographicRegionIdBstring

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

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

Global
PromotionOptionNostring

优惠券号码。

说明 仅国际站涉及该参数。
50003298014****
AutoRenewboolean

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

  • true:是。

  • false(默认值):否。

false
AutoRenewDurationinteger

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

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

说明 AutoRenewtrue 时,该项才生效。
1
ResourceGroupIdstring

资源组 ID。

rg-aekzrnd67gq****
Tagarray<object>

带宽包的标签。

object

带宽包的标签。

Keystring

带宽包的标签键。一旦输入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

最多支持输入 20 个标签键。

tag-key
Valuestring

带宽包的标签值。一旦输入该值,可以为空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

最多支持输入 20 个标签值。

tag-value

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

4B6DBBB0-2D01-4C6A-A384-4129266E6B78
BandwidthPackageIdstring

带宽包 ID。

gbwp-bp1sgzldyj6b4q7cx****
OrderIdstring

订单 ID。

如果您未自动支付账单,请您前往订单中心完成支付。 仅当 ChargeType 取值为 PREPAY,即付费方式为预付费时,返回该参数。如果 AutoPay 取值为 false,即未开启自动付费时,请前往订单中心完成支付。

208257****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400COMMODITY.INVALID_COMPONENTThe bandwidth parameter is incorrect or out of range-
400MissingParameter.BandwidthTypeYou must specify BandwidthType.入参缺少参数BandwidthType
500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.处理请求时出现错误,请稍后重试。

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

变更历史

变更时间变更内容概要操作
2023-04-20OpenAPI 错误码发生变更查看变更详情
2023-03-31OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情