All Products
Search

This Product

    Server Load Balancer:AssociateAclsWithListener

    Document Center

    Server Load Balancer:AssociateAclsWithListener

    Last Updated:Jun 18, 2024

    Associates access control lists (ACLs) with a listener.

    Operation description

    DeleteDhcpOptionsSet 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 ListAclRelations operation to query the status of the task.

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

    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
    alb:AssociateAclsWithListenerWrite
    • Acl
      acs:alb:{#regionId}:{#accountId}:acl/{#aclId}
    • LoadBalancer
      acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AclIdsarrayYes

    The IDs of the ACLs. You can specify up to three IDs in each call.

    stringYes

    The IDs of the ACLs. You can specify up to three IDs in each call.

    		nacl-hp34s2h0xx1ht4nwo****
    ListenerIdstringYes

    The ID of the listener.

    		lsr-bp1bpn0kn908w4nbw****
    AclTypestringYes

    The type of the ACL. Valid values:

    • White: a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. The whitelist applies to scenarios in which you want to allow only specific IP addresses to access an application. Your service may be adversely affected if the whitelist is not properly configured. If a whitelist is configured for a listener, only requests from IP addresses that are added to the whitelist are forwarded by the listener. If you enable a whitelist but do not add an IP address to the whitelist, the listener forwards all requests.
    • Black: a blacklist. All requests from the IP addresses or CIDR blocks in the ACL are blocked. The blacklist applies to scenarios in which you want to block access from specific IP addresses to an application. If a blacklist is configured for a listener but no IP address is added to the blacklist, the listener forwards all requests.
    		White
    DryRunbooleanNo

    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. 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
    ClientTokenstringNo

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

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

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		5A2CFF0E-5718-45B5-9D4D-70B3FF3898

    Response parameters

    ParameterTypeDescriptionExample
    object

    The operation to associate ACLs with a listener.

    JobIdstring

    The synchronous task ID.

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

    The request ID.

    		CEF72CEB-54B6-4AE8-B225-F876FF7BA984

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400QuotaExceeded.AclsNumThe quota of %s is exceeded, usage %s/%s.The quota of %s is exceeded, usage %s/%s.
    400IncorrectStatus.AclThe status of %s [%s] is incorrect.The status of %s [%s] is incorrect.
    400ResourceQuotaExceeded.ListenerAclEntriesNumThe quota of %s is exceeded for resource %s, usage %s/%s.The quota of %s is exceeded for resource %s, usage %s/%s.
    400OperationDenied.AclNotSupportThe operation is not allowed because of %s.-
    400ResourceAlreadyExist.AclEntryThe specified resource %s already exists.The specified resource %s already exists.
    400ResourceInUse.AclThe specified resource %s is in use.The specified resource %s is in use.
    404ResourceNotFound.AclThe specified resource %s is not found.The specified resource %s is not found.
    404ResourceNotFound.ListenerThe specified resource %s is not found.The specified resource %s is not found.

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

    Change history

    Change timeSummary of changesOperation
    2024-06-18The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2024-01-24The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2024-01-18The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
    2023-07-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404