Associate a common bandwidth package with a load balancer using AttachCommonBandwidthPackageToLoadBalancer - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Operation description

AttachCommonBandwidthPackageToLoadBalancer 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 GetLoadBalancerAttribute to query the status of the task:

If the ALB instance is in the Configuring state, the EIP bandwidth plan is being associated with the ALB instance.
If the ALB instance is in the Active state, the association is complete.

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

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. The token must be unique among different requests and can contain only ASCII characters. Note If not specified, the system uses the request ID as the client token. The request ID may differ for each request.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	Yes	The region ID of the ALB instance. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
LoadBalancerId	string	Yes	The ALB instance ID.	alb-d676fho813rmu3****
BandwidthPackageId	string	Yes	The EIP bandwidth plan ID.	cbwp-bp1pzf0ym72pu3y76****
DryRun	boolean	No	Specifies whether to perform a dry run, without performing the actual request. Valid values: true: performs a dry run without performing the actual request. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. 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): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	2EF39708-974B-5E74-AFF5-3445263035A8
JobId	string	The asynchronous task ID.	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.
400	IncorrectStatus.CommonBandwidthPackage	The status of %s [%s] is incorrect.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.