CreateCommonBandwidthPackage-阿里云帮助中心

Creates an Internet Shared Bandwidth instance.

Operation description

This operation supports only the creation of pay-as-you-go Internet Shared Bandwidth instances. To create a subscription Internet Shared Bandwidth instance, see Create an Internet Shared Bandwidth instance..

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:CreateCommonBandwidthPackage

create

*CommonBandwidthPackage

acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Internet Shared Bandwidth instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Zone	string	No	The zone of the Internet Shared Bandwidth instance. Required only when creating an instance for a CloudBox.	ap-southeast-1-lzdvn-cb
ISP	string	No	The line type. Valid values: BGP (default): BGP (multi-ISP) lines. All regions support BGP (multi-ISP) lines. BGP_PRO: BGP (multi-ISP) premium lines. Currently, only the Hong Kong (China), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions support BGP (multi-ISP) premium Internet Shared Bandwidth instances. If you are a single-ISP bandwidth whitelist user, you can also select the following types: 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 you are a Finance Cloud user in the China (Hangzhou) region, this parameter is required. Set the value to BGP_FinanceCloud.	BGP
Name	string	No	The name of the Internet Shared Bandwidth instance. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	test123
Description	string	No	The description of the Internet Shared Bandwidth instance. The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.	abc
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must ensure that the token is unique among different requests. The ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	02fb3da4-130e-11e9-8e44-001****
ResourceGroupId	string	No	The resource group ID.	rg-acfmxazdjdhd****
Bandwidth	integer	Yes	The peak bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. If InternetChargeType is set to PayByBandwidth, which indicates that the billable method of the Internet Shared Bandwidth instance is pay-by-bandwidth, the default value range of Bandwidth is 2 to 20000. If InternetChargeType is set to PayBy95, which indicates that the billable method of the Internet Shared Bandwidth instance is pay-by-enhanced-95th-percentile, the default value range of Bandwidth is 200 to 20000. If InternetChargeType is set to PayByDominantTraffic, which indicates that the billable method of the Internet Shared Bandwidth instance is pay-by-dominant-traffic, the default value range of Bandwidth is 1 to 2000. Default value: 1000. .	1000
Ratio	integer	No	The minimum bandwidth commitment percentage. Set the value to 20. This parameter is required when InternetChargeType is set to PayBy95. Note This parameter is supported only on the China site.	20
InternetChargeType	string	No	The billable method of the Internet Shared Bandwidth instance. Valid values: PayByBandwidth (default): pay-by-bandwidth. PayBy95: pay-by-enhanced-95th-percentile. PayByDominantTraffic: pay-by-dominant-traffic. .	中国站示例值：PayByBandwidth，国际站示例值：PayByTraffic
SecurityProtectionTypes	array	No	The security protection level. If you do not set this parameter, Anti-DDoS Origin Basic is used by default. If you set this parameter to AntiDDoS_Enhanced, Anti-DDoS Origin Enhanced is used. You can set this parameter when InternetChargeType is set to PayBy95. You can specify up to 10 security protection levels. Note This parameter is deprecated.	AntiDDoS_Enhanced
	string	No	The security protection level. If you do not set this parameter, Anti-DDoS Origin Basic is used by default. If you set this parameter to AntiDDoS_Enhanced, Anti-DDoS Origin Enhanced is used. You can set this parameter when InternetChargeType is set to PayBy95. Valid values of N: 1 to 10. Currently, only one security protection level can be specified. If you specify multiple levels, you may fail to invoke the operation. Note This parameter is deprecated.	AntiDDoS_Enhanced
Tag	array<object>	No	The list of tags.
	object	No
Key	string	No	The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	The response parameters.
BandwidthPackageId	string	The ID of the Internet Shared Bandwidth instance.	cbwp-bp1vevu8h3ieh****
RequestId	string	The request ID.	FF39F653-033E-4CD9-9EDF-3CCA5A71FBC3
ResourceGroupId	string	The resource group ID.	rg-acfmxazdjdhd****

Examples

Success response

JSON format

{
  "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 specified resource of Bandwidth is insufficient.
400	MissingParameter	Miss mandatory parameter.
400	InvalidParameter.Name.Malformed	The specified Name is not valid.
400	InvalidParameter.Description.Malformed	The specified Description is not valid.
400	BandwidthPackageOperation.conflict	BandwidthPackage operation conflict, please wait a moment and try again.
400	InvalidParameter.Bandwidth	The specified bandwidth is not valid.
400	BandwidthPackage.QuotaExceeded	Create BandwidthPackage has exceeded quota.
400	IllegalParam.Zone	Zone is illegal.
400	InvalidParameter.InvalidChargeType	The specified chargeType is not valid.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	The specified resource group ID does not exist.
400	OperationFailed.SaleValidate	Validate sale condition with subArticle failed.	Failed to validate the sales condition with a subproject.
400	OperationFailed.SyncOrderToSub	SyncOrderToSub error.	The operation failed.
400	IllegalParam.Ratio	The specified ratio is not valid.
400	OperationUnsupported.InvalidZone	It is not allowed to create CBWP in the specified zone.
400	IllegalParam.AvailableZone	%s
400	MissingParam.NameOrDescription	%s
400	UnsupportedRegion.CloudBoxInternet	The region does not support cloud box public network.	The region does not support cloud box public network.
400	ResourceNotEnough.CommonBandWidthPackage	The specified resource commonBandWidthPackage is not enough.	The specified resource commonBandWidthPackage is not enough.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.
404	InvalidVpcId.NotFound	Specified value of VpcId is not found in our record.	The VPC does not exist. Check whether the specified VPC is valid.
404	InvalidZoneId.NotFound	Specified value of ZoneId is not exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.