Creates a bandwidth plan for Cloud Enterprise Network (CEN) to enable cross-region connectivity between network instances.
Operation description
-
When you create a bandwidth plan instance, you must specify the connected areas. An area of a bandwidth plan is a collection of regions. Each area contains one or more Alibaba Cloud regions. 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.
-
CreateCenBandwidthPackage is an asynchronous operation. After you invoke the operation, the system returns a bandwidth plan instance ID but the bandwidth plan is not yet created. The creation node is still running in the background. You can invoke the DescribeCenBandwidthPackages operation to query the status of the bandwidth plan. When the bandwidth plan is in the Idle or InUse state, the bandwidth plan is created.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
cen:CreateCenBandwidthPackage |
create |
*CenBandwidthPackage
|
None | 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 make sure that the value is unique among different requests. The token can be up to 64 ASCII characters in length. |
02fb3da4-130e-11e9-8e44-001**** |
| Name |
string |
No |
The name of the bandwidth plan. The name can be empty or 1 to 128 characters in length and cannot start with http:// or https://. |
nametest |
| Description |
string |
No |
The description of the bandwidth plan. The description can be empty or 1 to 256 characters in length and cannot start with http:// or https://. |
namedesc |
| Bandwidth |
integer |
Yes |
The maximum bandwidth value 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 |
| GeographicRegionBId |
string |
Yes |
The area to which the other network instance belongs. Valid values:
|
China |
| BandwidthPackageChargeType |
string |
No |
The billing method of the bandwidth plan. Valid values: PREPAY, which indicates the subscription billing method. |
PREPAY |
| Period |
integer |
No |
The subscription duration of the bandwidth plan. Default value: 1.
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 |
| AutoPay |
boolean |
No |
Specifies whether to enable automatic payment for the bill of the bandwidth plan instance. Valid values:
If you set this parameter to false, go to the Order Center in the console to complete the payment after you invoke this operation. Otherwise, the instance cannot be created. |
false |
| Tag |
array<object> |
No |
Specifies whether to enable auto-renewal. Valid values:
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 You can specify up to 20 tag keys at a time. |
tagtest |
| Value |
string |
No |
The tag value of the resource. The tag value can be empty or up to 128 characters in length. It cannot start with Each tag key corresponds to one tag value. You can specify up to 20 tag values at a time. |
tagtest |
|
No |
The auto-renewal duration. Unit: months. Valid values: 0 to 2147483647. Default value: 1. |
1 |
||
|
No |
The tag information. You can specify up to 20 tags at a time. |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| CenBandwidthPackageId |
string |
The instance ID of the new bandwidth plan. |
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. | |
| 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.