All Products
Search
Document Center

Server Load Balancer:AttachCommonBandwidthPackageToLoadBalancer

Last Updated:Oct 26, 2026

Attaches an Internet Shared Bandwidth instance to an Application Load Balancer instance.

Operation description

The AttachCommonBandwidthPackageToLoadBalancer operation is asynchronous. After you send the request, the system returns a request ID, but the Internet Shared Bandwidth instance is not yet associated with the load balancing instance. The association task is still running in the background. You can call the GetLoadBalancerAttribute operation to query the association status of the Internet Shared Bandwidth instance:

  • When the load balancing instance is in the Configuring state, the Internet Shared Bandwidth instance is being associated.

  • When the load balancing instance is in the Active state, the Internet Shared Bandwidth instance is associated.

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

alb:AttachCommonBandwidthPackageToLoadBalancer

update

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

None None

Request parameters

Parameter

Type

Required

Description

Example

ClientToken

string

No

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must ensure that it is unique among different requests. The client token can contain only ASCII characters.

Note

If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique.

123e4567-e89b-12d3-a456-42665*****

RegionId

string

Yes

The region ID of the Application Load Balancer instance.

You can call the DescribeRegions operation to query region IDs.

cn-hangzhou

LoadBalancerId

string

Yes

The ID of the Application Load Balancer instance.

alb-d676fho813rmu3****

BandwidthPackageId

string

Yes

The ID of the Internet Shared Bandwidth instance to be associated.

cbwp-bp1pzf0ym72pu3y76****

DryRun

boolean

No

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run and does not associate the Internet Shared Bandwidth instance with the load balancing instance. The system checks whether the required parameters are specified, the request format is valid, and the service limits are met. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.

  • false (default): sends a normal request. If the request passes the check, an HTTP 2xx status code is returned and the operation is performed.

true

Response elements

Element

Type

Description

Example

object

Attaches an Internet Shared Bandwidth instance to an Application Load Balancer instance.

RequestId

string

The request ID.

2EF39708-974B-5E74-AFF5-3445******

JobId

string

The ID of the asynchronous task.

72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Success response

JSON format

{
  "RequestId": "2EF39708-974B-5E74-AFF5-3445263035A8",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 IncorrectBusinessStatus.CommonBandwidthPackage The business status of %s [%s] is incorrect. The business status of the resource %s [%s] is invalid.
400 IncorrectStatus.CommonBandwidthPackage The status of %s [%s] is incorrect. The status of the resource %s [%s] is invalid.
404 ResourceNotFound.LoadBalancer The specified resource %s is not found. The specified resource %s is not found.
404 ResourceNotFound.CommonBandwidthPackage The specified resource %s is not found. The resource %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.