All Products
Search
Document Center

Global Accelerator:ReplaceBandwidthPackage

Last Updated:May 16, 2024

Replaces the bandwidth plans of Global Accelerator (GA) instances.

Operation description

When you call this operation, take note of the following items:

  • The GA instance continues to forward network traffic.

  • ReplaceBandwidthPackage is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeAccelerator or ListAccelerators operation to query the status of the GA instance.

    • If the GA instance is in the configuring state, it indicates that the associated bandwidth plan is being replaced. In this case, you can perform only query operations.
    • If the GA instance is in the active state, it indicates that the associated bandwidth plan is replaced.
  • The ReplaceBandwidthPackage operation holds an exclusive lock on the GA instance. While the operation is in progress, you cannot call the same operation in the same Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ga:ReplaceBandwidthPackageWrite
  • BandwidthPackage
    acs:ga:{#regionId}:{#accountId}:bandwidthpackage/{#bandwidthPackageId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the GA instance. Set the value to cn-hangzhou.

cn-hangzhou
BandwidthPackageIdstringYes

The ID of the required bandwidth plan. When you specify a replacement bandwidth plan, take note of the following items:

  • Only a bandwidth plan that is not associated with a GA instance can be specified.
  • If you want to replace a basic bandwidth plan, make sure that the bandwidth provided by the replacement bandwidth plan is not less than the total bandwidth allocated to the acceleration area.
gbwp-bp176neb61yhcymow****
TargetBandwidthPackageIdstringYes

The ID of the bandwidth plan that you want to replace.

gbwp-o978hgeb61yhcymow****
AcceleratorIdstringNo

The GA instance ID.

ga-bp17frjjh0udz4qz****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

A0EA8CCA-F081-4338-9790-A1C791CCA779

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400NotExist.BandwidthPackageThe bandwidth package does not exist.The bandwidth package does not exist.
400StateError.BandwidthPackageThe state of bandwidth package is invalid.The bandwidth plan is in an invalid state.
400NotExist.BasicBandwidthPackageYou must specify the basic bandwidth package.You must specify the basic bandwidth package.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-11-15The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AcceleratorId