All Products
Search
Document Center

Global Accelerator:AssociateAclsWithListener

Last Updated:May 16, 2024

Associates access control lists (ACLs) with a listener.

Operation description

Description

  • AssociateAclsWithListener is an asynchronous operation. After you send a request, the system returns a request ID, but the operation is still being performed in the system background. You can call the DescribeListener operation to query the state of the listener with which you attempt to associate an ACL.

    • If the listener is in the updating state, it indicates that the ACL is being associated. In this case, you can perform only query operations.
    • If the listener is in the active state, it indicates that the ACL is associated.
  • The AssociateAclsWithListener operation cannot be called repeatedly for the same Global Accelerator (GA) instance within a specific period of time.

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
ga:AssociateAclsWithListenerWrite
  • Listener
    acs:ga:{#regionId}:{#accountId}:listener/{#ListenerId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the Global Accelerator (GA) instance. Set the value to cn-hangzhou.

cn-hangzhou
AclIdsarrayYes

The ID of the ACL. You can associate up to two ACL IDs.

stringYes

The ID of the ACL. You can associate up to two ACL IDs.

nacl-hp34s2h0xx1ht4nwo****
ListenerIdstringYes

The listener ID.

Only intelligent routing listeners support ACLs.

lsr-bp1bpn0kn908w4nbw****
AclTypestringYes

The type of the ACL. Valid values:

  • white: 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 access from specific IP addresses to an application. If a whitelist is improperly configured, risks may arise. After a whitelist is configured for a listener, only requests from the IP addresses that are added to the whitelist are distributed by the listener. If a whitelist is enabled but no IP address is added to the whitelist, the listener forwards all requests.
  • black: All requests from the IP addresses or CIDR blocks in the ACL are rejected. Blacklists are suitable for scenarios in which you want to deny access 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.
White
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.
02fb3da4****
DryRunbooleanNo

Specifies whether to only precheck the request. Default value: false. Valid values:

  • true: prechecks the request without performing the operation. The system checks the required parameters, request syntax, and limits. If the request fails the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false: sends the request. If the request passes the precheck, a 2xx HTTP status code is returned and the operation is performed.
false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
AclIdsarray

The ID of the ACL.

string

The ID of the ACL.

nacl-hp34s2h0xx1ht4nwo****
ListenerIdstring

The ID of the listener.

lsr-bp1bpn0kn908w4nbw****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400NotExist.Listenerlistener %s is not existThe listener %s does not exist.
400NotActive.Listenerlistener %s is not activeThe listener %s is unavailable.
400NotExist.Acceleratoraccelerator %s is not existThe GA instance %s does not exist.
400StateError.Acceleratoraccelerator state %s is illegalThe GA instance is in an invalid state %s.
400NotExist.Aclacl %s is not existThe ACL %s does not exist.
400StateError.Aclacl state %s is illegalThe status of the ACL %s is invalid.

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

Change history

Change timeSummary of changesOperation
2021-04-27Add Operationsee changesets