Modify maximum bandwidth using ModifyCommonBandwidthPackageSpec - Internet Shared Bandwidth - Alibaba Cloud - Internet Shared Bandwidth

Calls the ModifyCommonBandwidthPackageSpec operation to modify the peak bandwidth of an Internet Shared Bandwidth instance.

Operation description

Before you call this operation, take note of the following information:

ModifyCommonBandwidthPackageSpec is an asynchronous operation. After you send a request, the system returns a request ID, but the peak bandwidth of the Internet Shared Bandwidth instance has not been modified yet. The modification task is still running in the background. You can call DescribeCommonBandwidthPackages to query the status of the Internet Shared Bandwidth instance.
- If the Internet Shared Bandwidth instance is in the Modifying state, the peak bandwidth is being modified. In this state, you can only perform query operations and cannot perform other operations.
- If the Internet Shared Bandwidth instance is in the Available state, the peak bandwidth has been modified.
ModifyCommonBandwidthPackageSpec does not support concurrent modifications to the peak bandwidth of the same 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:ModifyCommonBandwidthPackageSpec

update

*BandwidthPackage

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Internet Shared Bandwidth instance. You can call DescribeRegions to query the region ID.	cn-hangzhou
BandwidthPackageId	string	Yes	The ID of the Internet Shared Bandwidth instance.	cbwp-2ze2ic1xd2qeqk145****
Bandwidth	string	Yes	The peak bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000.	1000

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7F129000-F929-4AF5-BE8D-BAE434C795306

Examples

Success response

JSON format

{
  "RequestId": "7F129000-F929-4AF5-BE8D-BAE434C795306"
}

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	InvalidParameter.Bandwidth	The specified bandwidth is not valid.
400	InvalidBandwidthPackageId.NotFound	The specified BandwidthPackageId not exist.
400	InvalidCommonBandwidthPackageId.NotFound	The specified BandwidthPackageId is not found.
400	IncorrectStatus.ResourceStatus	Resource status is abnormal for renew.
400	SYSTEM.SALE_VALIDATE_UNEXPECTED_ERROR	You have arrears and do not meet the purchase conditions.
400	OperationFailed.SyncOrderToSub	SyncOrderToSub error.	The operation failed.
400	OperationFailed.SaleValidate	Validate sale condition with subArticle failed.	Failed to validate the sales condition with a subproject.
400	OperationFailed.QueryCommodityInfo	Operation failed because quey commodity info error.
400	OperationFailed.QueryPrice	Query price failed when create order.	Failed to query the price when creating the order.
400	Forbidden.ChargeTypeIsPrepaid	It's forbidden to change prepaid CBWP's bandwidth by API. It can be changed on Aliyun web console.
400	IncorrectStatus.CbwpModifying	Cbwp Modifying status is invalid.
500	OrderError.BandwidthPackage	The Account failed to create order.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.
404	InvalidBandwidthPackageId.NotFound	The specified BandwidthPackageId does not exist in our records.
404	InvalidBandwidth.ValueNotSupported	The specified value of Bandwidth not supported.
404	BandwidthPackage.FinancialLocked	The specified BandwidthPackage has been Financial Lock.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.