All Products
Search

This Product

    Global Accelerator:BandwidthPackageAddAccelerator

    Document Center

    Global Accelerator:BandwidthPackageAddAccelerator

    Last Updated:Jun 30, 2026

    Invokes the BandwidthPackageAddAccelerator operation to attach a bandwidth plan to an Alibaba Cloud Global Accelerator (GA) instance.

    Operation description

    • BandwidthPackageAddAccelerator is an asynchronous operation. After you send a request, the system returns a request ID, but the bandwidth plan is not yet attached to the Alibaba Cloud Global Accelerator (GA) instance. The attachment node continues to run in the background. You can invoke DescribeBandwidthPackage to query the status of the bandwidth plan:

      • If the bandwidth plan is in the binding state, the bandwidth plan is being attached to the Alibaba Cloud Global Accelerator (GA) instance. In this state, you can only execute query operations.

      • If the bandwidth plan is in the active state, the bandwidth plan is attached to the Alibaba Cloud Global Accelerator (GA) instance.

    • The BandwidthPackageAddAccelerator operation does not support concurrent requests to attach bandwidth plans to the same Alibaba Cloud Global Accelerator (GA) 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

    ga:BandwidthPackageAddAccelerator

    update

    *BandwidthPackage

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

    *Accelerator

    acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Set the value to cn-hangzhou.

    cn-hangzhou
    BandwidthPackageId

    string

    Yes

    The ID of the bandwidth plan to attach to the Alibaba Cloud Global Accelerator (GA) instance.

    gbwp-bp1sgzldyj6b4q7cx****
    AcceleratorId

    string

    Yes

    The ID of the Alibaba Cloud Global Accelerator (GA) instance to which the bandwidth plan is attached.

    ga-bp1qe94o52ot4pkfn****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    B7770CB9-9745-4FE5-9EDA-D14B01A12A50
    Accelerators

    array

    The ID of the Alibaba Cloud Global Accelerator (GA) instance to which the bandwidth plan is attached.

    string

    The ID of the Alibaba Cloud Global Accelerator (GA) instance to which the bandwidth plan is attached.

    ga-bp1qe94o52ot4pkfn****
    BandwidthPackageId

    string

    The ID of the bandwidth plan attached to the Alibaba Cloud Global Accelerator (GA) instance.

    gbwp-bp1sgzldyj6b4q7cx****

    Examples

    Success response

    JSON format

    {
  "RequestId": "B7770CB9-9745-4FE5-9EDA-D14B01A12A50",
  "Accelerators": [
    "ga-bp1qe94o52ot4pkfn****"
  ],
  "BandwidthPackageId": "gbwp-bp1sgzldyj6b4q7cx****"
}

    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.
    400 StateError.Accelerator The state of the accelerated instance is invalid. The status of the GA instance is invalid.
    500 UnknownError An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. An error occurred while the request was being processed. Try again later.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.