Creates a bandwidth plan.

Descriptions

Before you use Cloud Enterprise Network (CEN) to connect network instances across regions, you must purchase a bandwidth plan based on the area to which the network instances belong.

An area is a collection of regions on Alibaba Cloud. Areas that support CEN include mainland China, Asia-Pacific, North America, Europe and Australia. The following table describes the areas and regions.

Area

Region

Mainland China

China (Qingdao), China (Beijing), China (Zhangjiakou-Beijing Winter Olympics), China (Shenzhen), China (Hangzhou), China (Shanghai), and China (Hohhot)

North America

US (Silicon Valley) and US (Virginia)

Asia-Pacific

China (Hong Kong), Singapore (Singapore), Malaysia (Kuala Lumpur), Japan (Tokyo), Indonesia (Jakarta), and India (Mumbai)

Europe

Germany (Frankfurt) and UK (London)

Australia

Australia (Sydney)

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No CreateCenBandwidthPackage

The operation that you want to perform. Set the value to CreateCenBandwidthPackage.

Bandwidth Integer Yes 2

The maximum bandwidth of the bandwidth plan. Unit: Mbit/s. Minimum value: 2.

GeographicRegionAId String Yes China

Area A to which the network instance belongs. Valid values:

  • China: Mainland China
  • North-America: North America
  • Asia-Pacific: Asia-Pacific
  • Europe: Europe
  • Australia: Australia
GeographicRegionBId String Yes China

Area B to which the other network instance belongs. Valid values:

  • China: Mainland China
  • North-America: North America
  • Asia-Pacific: Asia-Pacific
  • Europe: Europe
  • Australia: Australia
ClientToken String No SSJFLAFHHFHFF-SJSJJFBWHHE-SHHFJJDBD

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

Name String No cen

The name of the bandwidth plan. The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese character. It cannot start with http:// or https://.

Description String No BandwidthPlan

The description of the bandwidth plan.

BandwidthPackageChargeType String No PREPAY

The billing method of the bandwidth plan. Valid values:

  • POSTPAY: pay-as-you-go
  • PREPAY: subscription
Note You can purchase only subscription bandwidth plans on the Alibaba Cloud International site.
Period Integer No 1

The subscription duration of the bandwidth plan. Default value: 1.

PricingCycle String No Month

The billing cycle of the bandwidth plan. Valid values:

  • Month (default): billed on a monthly basis.
  • Year: billed on an annual basis.
AutoPay Boolean No true

Specifies whether to enable auto-renewal. Valid values:

  • true: enables auto-renewal.
  • false (default): disables auto-renewal.

Response parameters

Parameter Type Example Description
CenBandwidthPackageId String cenbwp-4c2zaavbvh5fx****

The ID of the newly created bandwidth plan.

CenBandwidthPackageOrderId String 201564200040390

The ID of the bandwidth plan order.

RequestId String 6547D2DA-4383-46A0-9E39-BA324492AD9F

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=CreateCenBandwidthPackage
&Bandwidth=2
&GeographicRegionAId=China 
&GeographicRegionBId=China 
&<Common request parameters>

Sample success responses

XML format

<CreateCenBandwidthPackageResponse>
      <RequestId>E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B</RequestId>
      <CenBandwidthPackageOrderId>201564200040390</CenBandwidthPackageOrderId>
      <CenBandwidthPackageId> Cenbwp-stb2axpqzzko2j****</CenBandwidthPackageId>
</CreateCenBandwidthPackageResponse>

JSON format

{
    "RequestId": "E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B",
    "CenBandwidthPackageOrderId": "201564200040390",
    "CenBandwidthPackageId": "Cenbwp-stb2axpqzzko2j****"
}

Error codes

HttpCode Error code Error message Description
400 UnSupported.ChargeType The charge type is not supported. The error message returned because the billing method is not supported.

For a list of error codes, visit the API Error Center.