Creates an EIP bandwidth plan.

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 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 query the most recent region list.

Zone String No cn-hangzhou-a

The zone where you want to create 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_PRO: BGP (Multi-ISP) Pro lines.
Note
  • BGP (Multi-ISP) lines are supported in all regions. BGP (Multi-ISP) Pro lines are supported only in China (Hong Kong).
  • If your Alibaba Cloud account is included in the BGP (Single ISP) whitelist, you can set the ISP parameter to ChinaTelecom, ChinaUnicom, or ChinaMobile. If your workloads are deployed in China East 1 Finance, this parameter is required and you must set the value 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 digits, periods (.), underscores (_), and hyphens (-). It must start with a letter but cannot start with http:// or https://.

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 and cannot exceed 64 characters in length.

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. 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. Unit: Mbit/s.

Valid values: 1 to 1000.

Ratio Integer No 20

The percentage of the minimum bandwidth commitment. Only 20 is supported.

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 specifies the pay-by-data-transfer billing method.

SecurityProtectionTypes.N String No AntiDDoS_Enhanced

The security level. Valid values of N: 1 to 10.

  • If you do not set this parameter, the basic Anti-DDoS protection feature is enabled.
  • If you set this parameter to AntiDDoS_Enhanced, the enhanced Anti-DDoS protection feature is enabled.

You can set this parameter if InternetChargeType is set to PayBy95.

Note This parameter is available only on the Alibaba Cloud China site.

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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateCommonBandwidthPackage
&RegionId=cn-hangzhou
&Zone=cn-hangzhou-a
&ISP=BGP
&Name=test123
&Description=abc
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&ResourceGroupId=rg-acfmxazdjdhd****
&Bandwidth=1000
&Ratio=20
Valid values for the InternetChargeType parameter: PayByBandwidth (Alibaba Cloud China site) and PayByTraffic (Alibaba Cloud International site).
&SecurityProtectionTypes=["AntiDDoS_Enhanced"]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateCommonBandwidthPackageResponse>
    <BandwidthPackageId>cbwp-bp1vevu8h3ieh****</BandwidthPackageId>
    <RequestId>FF39F653-033E-4CD9-9EDF-3CCA5A71FBC3</RequestId>
    <ResourceGroupId>rg-acfmxazdjdhd****</ResourceGroupId>
</CreateCommonBandwidthPackageResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode 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 the required parameters are not set. Check whether you have set all the required parameters before you call this operation.
400 InvalidParameter.Name.Malformed The specified Name is not valid. The error message returned because the specified name is invalid.
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.
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 virtual private cloud (VPC) does not exist. Check whether the specified VPC 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, visit the API Error Center.