Creates an Internet Shared Bandwidth instance.

Make the API call

You can use OpenAPI Explorer to make API calls, search for API calls, perform debugging, and generate SDK example code.

Request parameters

Parameter Type Required? Example value Description
Action String Yes CreateCommonBandwidthPackage

The name of this action. Value: CreateCommonBandwidthPackage

Bandwidth Integer Yes 5

The peak bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s.

RegionId String Yes cn-hangzhou

The region to which the Internet Shared Bandwidth instance belongs. To query the region ID, call DescribeRegions.

Zone String No cn-hangzhou-b

The zone of the Internet Shared Bandwidth instance.

You do not need to specify this parameter.

ISP String No BGP

The line type of the Elastic IP address. Valid value: BGP(Multi-line)

Name String No test123

The name of the Internet Shared Bandwidth instance.

The name must be 2 to 128 characters in length and can contain letters, numbers, periods (.), underscores (_), and hyphens (-). The name must start with a letter, and cannot start with http:// or https://.

Description String No abc

The description of the Internet Shared Bandwidth instance.

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

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

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

ResourceGroupId String No rg-acfmxazdjdhd****

The ID of the resource group.

Ratio Integer No 20

The minimum consumption ratio of the Internet Shared Bandwidth instance. Value: 20.

Note This parameter is only supported on the China site.
InternetChargeType String No PayByTraffic

The billing model of the Internet Shared Bandwidth instance. Value: PayByTraffic.

Response parameters

Parameter Type Example value Description
RequestId String FF39F653-033E-4CD9-9EDF-3CCA5A71FBC3

The ID of the request.

BandwidthPackageId String cbwp-bp1vevu8h3ieh****

The ID of the Internet Shared Bandwidth instance.

ResourceGroupId String rg-acfmxazdjdhd****

The ID of the resource group.

Examples

Request example

http(s)://[Endpoint]/? Action=CreateCommonBandwidthPackage
&Bandwidth=5
&RegionId=cn-hangzhou
&<CommonParameters>

Response example

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"
    }
}

Errors

HTTP status code Error code Error message Description
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. The specified RegionId does not exist.
404 InvalidVpcId.NotFound Specified value of VpcId is not found in our record. The specified VPC does not exist.
400 MissingParameter Miss mandatory parameter. One or more mandatory parameters are missing.
404 InvalidZoneId.NotFound Specified value of ZoneId is not exists. The specified zone does not exist.
400 InvalidParameter.Name.Malformed The specified Name is not valid. The specified name is invalid.
400 InvalidParameter.Description.Malformed The specified Description is not valid. The specified description is invalid.

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