Creates an EIP bandwidth plan.


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 Yes CreateCommonBandwidthPackage

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

RegionId String Yes cn-hangzhou

The region ID of the EIP bandwidth plan.

You can call the DescribeRegions operation to obtain the region ID.

Zone String No cn-hangzhou-a

The zone of the EIP bandwidth plan.

You do not need to set this parameter.

ISP String No BGP

The line type. Valid values:

  • BGP: BGP (Multi-ISP) lines. BGP (Multi-ISP) lines are available in all regions.
  • BGP_PRO: BGP (Multi-ISP) Pro lines. BGP (Multi-ISP) Pro is available only in the China (Hong Kong), Singapore, Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

If you are allowed to use single-ISP bandwidth, you can also choose one of the following values:

  • ChinaTelecom: China Telecom
  • ChinaUnicom: China Unicom
  • ChinaMobile: China Mobile
  • ChinaTelecom_L2: China Telecom L2
  • ChinaUnicom_L2: China Unicom L2
  • ChinaMobile_L2: China Mobile L2

If your services are deployed in China East 1 Finance, you must set this parameter to BGP_FinanceCloud.

Name String No test123

The name of the EIP bandwidth plan.

The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

Description String No abc

The description of the EIP bandwidth plan.

The description must be 2 to 256 characters in length. It must start with a letter but cannot start with http:// or https://.

ClientToken String No 02fb3da4-130e-11e9-8e44-001****

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 it is unique among different requests. The token can contain only ASCII characters.

Note If you do not set this parameter, the system automatically sets the ClientToken parameter to the value of RequestId. The value of RequestId may be different for each API request.
ResourceGroupId String No rg-acfmxazdjdhd****

The ID of the resource group.

Bandwidth Integer Yes 1000

The maximum bandwidth of the EIP bandwidth plan.

Valid values: 1 to 1000. Unit: Mbit/s.

Ratio Integer No 20

The percentage of the minimum bandwidth commitment. Set the parameter to 20.

Note This parameter is available only on the Alibaba Cloud China site.
InternetChargeType String No Alibaba Cloud China site: PayByBandwidth. Alibaba Cloud International site: PayByTraffic

The billing method of the EIP bandwidth plan. Set the value to PayByTraffic, which refers to the pay-by-data-transfer metering method.

SecurityProtectionTypes.N String No AntiDDoS_Enhanced

The edition of Anti-DDoS.

  • If you do not set this parameter, Anti-DDoS Origin Basic is used.
  • If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro/Premium is used.

Valid values of N: 1 to 10. You can specify only one Anti-DDoS edition. If you specify more than one edition, the operation may fail.

Response parameters

Parameter Type Example Description
BandwidthPackageId String cbwp-bp1vevu8h3ieh****

The ID of the EIP bandwidth plan.

RequestId String FF39F653-033E-4CD9-9EDF-3CCA5A71FBC3

The ID of the request.

ResourceGroupId String rg-acfmxazdjdhd****

The ID of the resource group.


Sample requests

&InternetChargeType = PayByBandwidth (Alibaba Cloud China site) or PayByTraffic (Alibaba Cloud International site)
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK


JSON format

HTTP/1.1 200 OK

  "BandwidthPackageId" : "cbwp-bp1vevu8h3ieh****",
  "RequestId" : "FF39F653-033E-4CD9-9EDF-3CCA5A71FBC3",
  "ResourceGroupId" : "rg-acfmxazdjdhd****"

Error codes

HTTP status code Error code Error message Description
400 ResourceNotEnough.Bandwidth The specified resource of Bandwidth is not enough. The error message returned because bandwidth resources are insufficient.
400 MissingParameter Miss mandatory parameter. The error message returned because one or more required parameters are not set. Check whether all required parameters are set before you call this operation.
400 InvalidParameter.Name.Malformed The specified Name is not valid. The error message returned because the specified name format is invalid. Enter the name in the valid format.
400 InvalidParameter.Description.Malformed The specified Description is not valid. The error message returned because the specified description is invalid.
400 InvalidResourceGroupId The specified ResourceGroupId does not exist. The error message returned because the specified resource group ID is invalid.
400 OperationFailed.SyncOrderToSub SyncOrderToSub error. The error message returned because the operation failed.
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. The error message returned because the specified region ID does not exist.
404 InvalidVpcId.NotFound Specified value of VpcId is not found in our record. The error message returned because the specified VPC does not exist. Check whether the specified VPC ID is valid.
404 InvalidZoneId.NotFound Specified value of ZoneId is not exists. The error message returned because the specified zone does not exist.

For a list of error codes, see Service error codes.