CreateCenBandwidthPackage - 创建带宽包

要实现跨地域网络实例互通,您必须购买带宽包,您可以调用CreateCenBandwidthPackage接口创建带宽包。

接口说明

  • 在创建带宽包实例时需要指定互通区域。带宽包的区域是地域的集合,每个区域包含一个或多个阿里云地域,您可以根据要互通的地域来选择带宽包的互通区域。关于区域和地域的关系,请参见购买带宽包

  • 带宽包的计费详情,请参见计费说明

  • CreateCenBandwidthPackage 接口属于异步接口,即系统会先返回一个带宽包实例 ID,但该带宽包并未创建完成,系统后台的创建任务仍在进行。您可以调用 DescribeCenBandwidthPackages 接口查询带宽包的状态,当带宽包处于 IdleInUse 状态时,表示带宽包创建完成。

调试

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

授权信息

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

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

请求参数

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

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

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

02fb3da4-130e-11e9-8e44-001****
Namestring

带宽包实例的名称。

名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。

nametest
Descriptionstring

带宽包实例的描述信息。

描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。

namedesc
Bandwidthinteger

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

2
GeographicRegionAIdstring

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

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

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

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

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

PREPAY
Periodinteger

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

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

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

  • Month(默认值):按月计费。

  • Year:按年计费。

Month
AutoPayboolean

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

  • true:是。

  • false(默认值):否。

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

false
AutoRenewboolean

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

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

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

1
Tagarray<object>

标签信息。

一次最多支持输入 20 个标签信息。

object
Keystring

资源的标签键。

一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以aliyun或者acs:开头,不能包含http://或者https://

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

tagtest
Valuestring

资源的标签值。

标签值可以为空或输入不超过 128 个字符的字符串,不能以aliyun或者acs:开头,不能包含http://或者https://

每一个标签键对应一个标签值,一次最多支持输入 20 个标签键对应的标签值。

tagtest

返回参数

名称类型描述示例值
object

返回结果。

CenBandwidthPackageIdstring

新建的带宽包实例 ID。

cenbwp-4c2zaavbvh5fx****
CenBandwidthPackageOrderIdstring

带宽包实例的订单 ID。

20156420004****
RequestIdstring

请求 ID。

E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400UnSupported.ChargeTypeThe charge type is not supported.不支持该付费类型。
400ParameterIllegal.BandwidthPackageThe parameter of bandwidth packaged is illegal.参数中指定的BandwidthPackage不合法。
400OperationInvalid.UserCanNotBuyCrossBorderBwpAccording to the laws and regulations of the operator and mainland China, you are currently not eligible to purchase or renew a cross-border bandwidth package. Please contact online customer service or your business manager for consultation.根据运营商及中国大陆法律法规的要求,您当前暂不符合购买/续费跨境带宽包条件,请联系在线客服或您的商务经理咨询处理。
400OperationInvalid.UserCanNotBuyBwpThe user can not buy Cen bandwidthPackage.用户不允许购买CEN带宽包
400Order.AccountStatusIllegalIllegal account status for postpay service not opened for this account.账号未开通后付费白名单,请开通后重试。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。
500PayFor.AccountMoneyValidateErrorYour channel merchant quota is insufficient. Please contact the channel merchant.您的渠道商额度不足,请与渠道商联系

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

变更历史

变更时间变更内容概要操作
2024-11-22OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2024-07-26OpenAPI 错误码发生变更查看变更详情
2024-05-17OpenAPI 错误码发生变更查看变更详情
2023-12-13OpenAPI 错误码发生变更查看变更详情
2023-07-13OpenAPI 错误码发生变更查看变更详情