UpdateBandwidthPackage - Global Accelerator - Alibaba Cloud Documentation Center

Operation description

Before you call this operation, note the following:

If you do not change the bandwidth value, UpdateBandwidthPackage is a synchronous operation. The modification takes effect immediately.
If you change the bandwidth value of a bandwidth plan that is not associated with a Global Accelerator (GA) instance, UpdateBandwidthPackage is an asynchronous operation. The system returns a request ID, but the modification is not complete. The system performs the task in the background. You can call the DescribeBandwidthPackage operation to query whether the configuration of the bandwidth plan is modified:
- If the values of the parameters that you want to modify remain unchanged, the bandwidth plan is being modified. In this case, you can only perform query operations.
- If the values of the parameters that you want to modify have changed, the modification is complete.
If you change the bandwidth value of a bandwidth plan that is associated with a GA instance, UpdateBandwidthPackage is an asynchronous operation. The system returns a request ID, but the modification is not complete. The system performs the task in the background. You can call the DescribeAccelerator operation and query the status of the GA instance to check whether the bandwidth plan is modified:
- If the GA instance is in the configuring state, the bandwidth plan that is associated with the GA instance is being modified. In this case, you can only perform query operations.
- If the GA instance is in the active state, the bandwidth plan that is associated with the GA instance has been modified.
You cannot repeatedly call the UpdateBandwidthPackage operation to modify the configuration of the same bandwidth plan.

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 support 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

ga:UpdateBandwidthPackage

update

*BandwidthPackage

acs:ga:{#regionId}:{#accountId}:bandwidthpackage/{#bandwidthPackageId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
BandwidthPackageId	string	Yes	The ID of the bandwidth plan that you want to modify.	gbwp-bp1sgzldyj6b4q7cx****
Name	string	No	The name of the bandwidth plan. The name must be 1 to 128 characters in length, start with a letter or a Chinese character, and can contain letters, digits, periods (.), underscores (_), and hyphens (-).	testName
Description	string	No	The description of the bandwidth plan. The description can be up to 256 characters in length.	testDescription
Bandwidth	integer	No	The bandwidth of the bandwidth plan. Unit: Mbit/s. Valid values: 2 to 2000.	2
BandwidthType	string	No	The bandwidth type. Valid values: Basic: standard bandwidth. Enhanced: enhanced bandwidth. Advanced: premium bandwidth. Note You can upgrade a Basic bandwidth plan to Enhanced, or downgrade an Enhanced bandwidth plan to Basic. You cannot change the bandwidth type of an Advanced bandwidth plan.	Basic
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: false (default): disables automatic payment. After an order is generated, you must go to the Order Hub to complete the payment. true: enables automatic payment. The system automatically pays the bill. Note This parameter is required only for upgrade orders.	false
AutoUseCoupon	boolean	No	Specifies whether to use coupons. Valid values: true: yes. false (default): no.	false

Response parameters

Parameter	Type	Description	Example
	object	The response.
BandwidthPackage	string	The ID of the bandwidth plan.	gbwp-bp1eo4f57z1kbbcmn****
Description	string	The description of the bandwidth plan.	testDescription
RequestId	string	The request ID.	1DF3A3CB-B621-44F8-9870-C20D034D7AB
Name	string	The name of the bandwidth plan.	testName

Examples

Success response

JSON format

{
  "BandwidthPackage": "gbwp-bp1eo4f57z1kbbcmn****",
  "Description": "testDescription",
  "RequestId": "1DF3A3CB-B621-44F8-9870-C20D034D7AB",
  "Name": "testName"
}

Error codes

HTTP status code	Error code	Error message	Description
400	COMMODITY.INVALID_COMPONENT	The Basic type only can be upgraded to the Enhanced, and the Enhanced type only can be downgraded to the Basic . The type of the Advance bandwidth can not be changed.
400	StateError.BandwidthPackage	The state of bandwidth package is invalid.	The bandwidth plan is in an invalid state.
400	NotExist.BandwidthPackage	The bandwidth package does not exist.	The bandwidth package does not exist.
400	UpgradeError.BandwidthPackage	The bandwidth package configurations should be either all upgrades or all downgrades.	You cannot upgrade and downgrade a bandwidth plan at the same time. You can only upgrade or downgrade the bandwidth plan.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.