ReplaceBandwidthPackage - Replace bandwidth plan | GA API - Global Accelerator

Operation description

Note the following when you call this operation:

The GA instance continues to forward network traffic.
ReplaceBandwidthPackage is asynchronous. After a request is sent, the system returns a request ID and runs the task in the background. Call DescribeAccelerator or ListAccelerators to query the GA instance status.
- If the GA instance is in the configuring state, the bandwidth plan is being replaced. You can perform only query operations.
- If the GA instance is in the active state, the bandwidth plan replacement is complete.
ReplaceBandwidthPackage holds an exclusive lock on the GA instance. While in progress, you cannot call this operation again from the same Alibaba Cloud account.

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

ga:ReplaceBandwidthPackage

update

*BandwidthPackage

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the GA instance. Set the value to cn-hangzhou.	cn-hangzhou
BandwidthPackageId	string	Yes	The ID of the replacement bandwidth plan. Note the following: The bandwidth plan must not be associated with any GA instance. To replace a basic bandwidth plan, ensure that the replacement provides at least as much bandwidth as the total allocated to the acceleration area.	gbwp-bp176neb61yhcymow****
TargetBandwidthPackageId	string	Yes	The ID of the bandwidth plan that you want to replace.	gbwp-o978hgeb61yhcymow****
AcceleratorId	string	No	The GA instance ID.	ga-bp17frjjh0udz4qz****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	A0EA8CCA-F081-4338-9790-A1C791CCA779

Examples

Success response

JSON format

{
  "RequestId": "A0EA8CCA-F081-4338-9790-A1C791CCA779"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotExist.BandwidthPackage	The bandwidth package does not exist.	The bandwidth package does not exist.
400	StateError.BandwidthPackage	The state of bandwidth package is invalid.	The bandwidth plan is in an invalid state.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	You must specify the basic bandwidth package.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.