All Products
Search
Document Center

Server Load Balancer:AssociateAclsWithListener

Last Updated:Oct 23, 2026

Associates access control lists with a listener.

Operation description

The AssociateAclsWithListener operation is asynchronous. After you call this operation, the system returns a request ID, but the ACLs are not yet associated with the listener. The association task is still running in the background. You can call ListAclRelations to query the association status of the ACLs:

  • If the ACL is in the Associating state, the ACL is being associated with the listener.

  • If the ACL is in the Associated state, the ACL is associated with the listener.

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:AssociateAclsWithListener

create

*Acl

acs:alb:{#regionId}:{#accountId}:acl/{#aclId}

*LoadBalancer

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

None None

Request parameters

Parameter

Type

Required

Description

Example

AclIds

array

Yes

The ACL instance IDs. You can specify up to three ACL instance IDs.

string

No

The ACL instance ID.

acl-hp34s2h0xx1ht4nwo****

ListenerId

string

Yes

The listener instance ID. Before you invoke this operation, confirm that the Application Load Balancer (ALB) instance to which the listener belongs is not associated with a security group. After an ALB instance is associated with a security group, you cannot attach an access control policy to the instance.

lsn-bp1bpn0kn9*******

AclType

string

Yes

The access control type. Valid values:

  • White: specifies a whitelist. Only requests from the IP addresses or CIDR blocks in the Settings of the selected access control policy group are forwarded. Whitelists apply to scenarios in which you want to allow only specific IP addresses to access an application. Configuring a whitelist poses risks to your business. After a whitelist is configured, only the IP addresses in the whitelist can access the load balancing listener. If you enable a whitelist but do not add IP addresses to the access control policy group, the load balancing listener forwards all requests.

  • Black: specifies a blacklist. Requests from the IP addresses or CIDR blocks in the Settings of the selected access control policy group are not forwarded. Blacklists apply to scenarios in which you want to block access from specific IP addresses. If you enable a blacklist but do not add IP addresses to the access control policy group, the load balancing listener forwards all requests.

White

DryRun

boolean

No

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run and does not associate the ACLs with the listener. The system checks whether the required parameters are set, and validates the request format 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 sends the actual request. If the request passes the dry run, an HTTP 2xx status code is returned and the operation is performed.

true

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, and you must make sure that the value is unique among different requests. The client token can contain only ASCII characters.

Note

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

5A2CFF0E-5718-45B5-9D4D-70B******

Response elements

Element

Type

Description

Example

object

The response for associating access control lists with a listener.

JobId

string

The ID of the asynchronous task.

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

RequestId

string

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F87******

Examples

Success response

JSON format

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Error codes

HTTP status code

Error code

Error message

Description

400 QuotaExceeded.AclsNum The quota of %s is exceeded, usage %s/%s. The quota of %s is exceeded, usage %s/%s.
400 IncorrectStatus.Acl The status of %s [%s] is incorrect. The current status of the access control policy group ACL does not support this operation.
400 ResourceQuotaExceeded.ListenerAclEntriesNum The quota of %s is exceeded for resource %s, usage %s/%s. The quota of %s is exceeded for resource %s, usage %s/%s.
400 OperationDenied.AclNotSupport The operation is not allowed because of %s. The operation is not allowed because %s.
400 ResourceAlreadyExist.AclEntry The specified resource %s already exists. The IP entry already exists in the access control policy group.
400 ResourceInUse.Acl The specified resource %s is in use. The specified resource %s is in use.
400 OperationDenied.LoadBalancerJoinedSecurityGroupNotSupportAcl The operation is not allowed because of loadbalancer joined security group not support acl. The operation is not supported because SLB instances in security groups cannot be added to ACLs.
404 ResourceNotFound.Acl The specified resource %s is not found. The access control policy group ACL does not exist.
404 ResourceNotFound.Listener The specified resource %s is not found. The listener does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.