Associates access control lists (ACLs) with a listener.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AssociateAclsWithListener

The operation that you want to perform. Set the value to AssociateAclsWithListener.

RegionId String Yes 64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF

The ID of the request.

ListenerId String Yes lsr-bp1bpn0kn908w4nbw****

The ID of the listener.

AclType String Yes white

The type of the ACL. Valid values:

  • white: specifies the ACL as a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists are suitable for scenarios in which you want to allow only specified IP addresses to access an application. If you specify the ACL as a whitelist, errors may occur. Proceed with caution. After you configure a whitelist for a listener, only requests from the IP addresses that are added to the whitelist are distributed by the listener. If the whitelist is enabled but no IP addresses are added to the ACL, the listener does not forward requests.
  • Black: a blacklist. All requests from the IP addresses or CIDR blocks in the ACL are denied. Blacklists are suitable for scenarios in which you want to deny requests from specific IP addresses to an application. If the blacklist is enabled but no IP addresses are added to the ACL, the listener forwards all requests.
ClientToken String No 02fb3da4****

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 token can only contain ASCII characters, and cannot exceed 64 characters in length.

DryRun Boolean No true

Specifies whether only to precheck the request. Valid values:

  • true: prechecks the request without creating resources. The system checks the required parameters, request format, and service limits. If the request fails the precheck, the system returns an error code based on the cause of the failure. If the precheck is successful, the error code DryRunOperation is returned.
  • false: sends the request. If the precheck is successful, a 2xx HTTP status code is returned and the operation is performed. Default value: false.
AclIds.N String Yes nacl-hp34s2h0xx1ht4nwo****

The ID of the ACL. You can associate at most two ACLs with a listener.

Response parameters

Parameter Type Example Description
RequestId String 64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF

The ID of the request.

AclIds Array of String nacl-hp34s2h0xx1ht4nwo****

The ID of the ACL. You can associate at most two ACLs with a listener.

ListenerId String lsr-bp1bpn0kn908w4nbw****

The ID of the listener.

Examples

Sample requests

http(s)://[Endpoint]/?Action=AssociateAclsWithListener
&RegionId=64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
&AclIds=["nacl-hp34s2h0xx1ht4nwo****"]
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&AclType=white
&ClientToken=02fb3da4****
&DryRun=true
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<AssociateAclsWithListenerResponse>
    <RequestId>64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF</RequestId>
    <AclIds>nacl-hp34s2h0xx1ht4nwo****</AclIds>
    <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>
</AssociateAclsWithListenerResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF",
  "AclIds" : [ "nacl-hp34s2h0xx1ht4nwo****" ],
  "ListenerId" : "lsr-bp1bpn0kn908w4nbw****"
}

Error codes

For a list of error codes, visit the API Error Center.