You can call this operation to create 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 Position Type Required Example Description
Action Query String Yes CreateCommonBandwidthPackage

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

Bandwidth Query Integer Yes 5

The maximum bandwidth of the EIP bandwidth plan. Valid values:

1 to 1000.

Unit: Mbit/s.

RegionId Query String Yes cn-hangzhou

The region where the EIP bandwidth plan is applied. You can call the DescribeRegions operation to query region IDs.

Zone Query String No cn-hangzhou-a

The zone where the EIP bandwidth plan is applied.

You do not need to set this parameter.

ISP Query 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).
Name Query 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, periods (.), underscores (_), and hyphens (-). The name must start with a letter or Chinese character and cannot start with http:// or https://.

Description Query String No abc

The description of the EIP bandwidth plan.

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

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

The client token is used to ensure the idempotence of the request. The value of this parameter is generated by a client. The value must be unique among different requests and must be 1 to 64 ASCII characters in length.

ResourceGroupId Query String No rg-acfmxazdjdhd****

The ID of the resource group.

Ratio Query Integer No 20

The minimum bandwidth guaranteed in percentile. If this value is set to: 20, 20% of the total bandwidth is guaranteed.

Note This parameter is only available for EIP bandwidth plans purchased on the Alibaba Cloud China site.
InternetChargeType Query 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.

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
&Bandwidth=5
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

HttpCode Error code Error message Description
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 network does not exist. Check whether the specified VPC network ID is valid.
400 MissingParameter Miss mandatory parameter. The error message returned because the required parameters are missing. Check whether you have set all the required parameters before you call this operation.
404 InvalidZoneId.NotFound Specified value of ZoneId is not exists. The error message returned because the specified Zone ID does not exist.
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.

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