Use CreateCenBandwidthPackage to create a bandwidth plan - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Creates a bandwidth plan. To enable communication between network instances across regions, you must purchase a bandwidth plan.

Operation description

When you create a bandwidth plan instance, you must specify the connected areas. An area is a collection of regions. Each area contains one or more Alibaba Cloud regions. You can select the connected areas based on the regions that you want to connect. For more information about the relationship between areas and regions, see Purchase a bandwidth plan.
For more information about the billing details of bandwidth plans, see Billing overview.
The CreateCenBandwidthPackage operation is asynchronous. The system returns the instance ID of the bandwidth plan before the bandwidth plan is created. The creation node is still running in the background. You can invoke the DescribeCenBandwidthPackages operation to query the status of the bandwidth plan. If the bandwidth plan is in the Idle or InUse state, the bandwidth plan is created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:CreateCenBandwidthPackage

create

*CenBandwidthPackage

acs:cen:*:{#accountId}:cenbandwidthpackage/*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	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 contain only ASCII characters and cannot exceed 64 characters in length.	02fb3da4-130e-11e9-8e44-001****
Name	string	No	The name of the bandwidth plan. The name must be 1 to 128 characters in length, and can be left empty. It cannot start with http:// or https://.	nametest
Description	string	No	The description of the bandwidth plan. The description must be 1 to 256 characters in length, and can be left empty. It cannot start with http:// or https://.	namedesc
Bandwidth	integer	Yes	The maximum bandwidth of the bandwidth plan. Unit: Mbit/s. Valid values: 2 to 10000.	2
GeographicRegionAId	string	Yes	The area to which the network instance belongs. Valid values: China: the Chinese mainland. North-America: North America. Asia-Pacific: Asia-Pacific. Europe: Europe.	China
GeographicRegionBId	string	Yes	The area to which the other network instance belongs. Valid values: China: the Chinese mainland. North-America: North America. Asia-Pacific: Asia-Pacific. Europe: Europe.	China
BandwidthPackageChargeType	string	No	The billing method of the bandwidth plan. Valid values: PREPAY: subscription.	PREPAY
Period	integer	No	The subscription duration of the bandwidth plan. Default value: 1. If PricingCycle is set to Month, valid values of Period are 1 to 3 and 6. If PricingCycle is set to Year, valid values of Period are 1 to 3. Note This parameter is required when BandwidthPackageChargeType is set to PREPAY.	1
PricingCycle	string	No	The billing cycle of the bandwidth plan. Valid values: Month (default): billed on a monthly basis. Year: billed on a yearly basis.	Month
AutoPay	boolean	No	Specifies whether to enable automatic payment for the bill of the bandwidth plan instance. Valid values: true: yes. false (default): no. If you choose not to use automatic payment, after you invoke this operation, you must go to the Order Center in the console to complete the payment. Otherwise, the instance cannot be created.	false
Tag	array<object>	No	Specifies whether to enable auto-renewal. Valid values: true: yes. false (default): no. Note Only subscription bandwidth plans support auto-renewal.	false
	object	No
Key	string	No	The tag key of the resource. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`. You can specify up to 20 tag keys at a time.	tagtest
Value	string	No	The tag value of the resource. The tag value cannot be empty. The tag value can be up to 128 characters in length and cannot start with aliyun or acs:. The tag value cannot contain http:// or https://. Each tag key has a unique tag value. You can specify up to 20 tag values at a time.	tagtest

Response elements

Element	Type	Description	Example
	object	The returned result.
CenBandwidthPackageId	string	The instance ID of the created bandwidth plan instance.	cenbwp-4c2zaavbvh5fx****
CenBandwidthPackageOrderId	string	The order ID of the bandwidth plan.	20156420004****
RequestId	string	The request ID.	E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	UnSupported.ChargeType	The charge type is not supported.	The error message returned because the specified billing method is not supported.
400	ParameterIllegal.BandwidthPackage	The parameter of bandwidth packaged is illegal.	The error message returned because the specified bandwidth plan (BandwidthPackage) is invalid.
400	OperationInvalid.UserCanNotBuyCrossBorderBwp	According 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.	According 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.
400	OperationInvalid.UserCanNotBuyBwp	The user can not buy Cen bandwidthPackage.
400	Order.AccountStatusIllegal	Illegal account status for postpay service not opened for this account.	Illegal account status for postpay service not opened for this account.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	The input parameter Tag Value is invalid.
500	PayFor.AccountMoneyValidateError	Your channel merchant quota is insufficient. Please contact the channel merchant.	Your channel partner does not have sufficient quotas. Contact your channel partner.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.