Bind ACLs to a GA Listener for Access Control via API - Global Accelerator - Alibaba Cloud - Global Accelerator

Operation description

AssociateAclsWithListener is an asynchronous operation. After a request is sent, the system returns a request ID, but the access control policy groups are not yet associated with the listener. The association node is still being executed in the background. You can invoke DescribeListener to query the status of the listener:
- If the listener is in the updating state, the access control policy groups are being associated with the listener. In this state, you can only execute query operations and cannot execute other operations.
- If the listener is in the active state, the access control policy groups are associated with the listener.
The AssociateAclsWithListener operation does not support concurrently associating access control policy groups with a listener within the same Alibaba Cloud Global Accelerator (GA) instance.

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

ga:AssociateAclsWithListener

update

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#ListenerId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Global Accelerator instance. Set the value to cn-hangzhou.	cn-hangzhou
AclIds	array	Yes	The ID of the access control policy group. You can associate up to two access control policy groups.
	string	No	The ID of the access control policy group. You can associate up to two access control policy groups.	nacl-hp34s2h0xx1ht4nwo****
ListenerId	string	Yes	The listener ID. Only intelligent routing listeners support the access control feature.	lsr-bp1bpn0kn908w4nbw****
AclType	string	Yes	The type of access control. Valid values: white: Only requests from the IP addresses or CIDR blocks set in the selected access control policy groups are forwarded. Whitelists are applicable to scenarios in which you want to allow only specific IP addresses to access your application. Risks may arise if you set a whitelist. After you set a whitelist, only the IP addresses in the whitelist can access the Global Accelerator listener. If a whitelist is enabled but no IP addresses are added to the access control policy groups, the Global Accelerator listener forwards all requests. black: All requests from the IP addresses or CIDR blocks set in the selected access control policy groups are denied. Blacklists are applicable to scenarios in which you want to deny access from specific IP addresses. If a blacklist is enabled but no IP addresses are added to the access control policy groups, the Global Accelerator listener forwards all requests.	white
ClientToken	string	No	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 RequestId value as the ClientToken value. The RequestId value is different for each API request.	02fb3da4****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: sends a dry run request without associating the resource. The system checks the required parameters, request syntax, and business limits. If the request fails the check, the corresponding error is returned. If the request passes the check, the error code `DryRunOperation` is returned. false (default): sends a request. After the request passes the check, an HTTP 2xx status code is returned and the operation is performed.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
AclIds	array	The ID of the access control policy group.
	string	The ID of the access control policy group.	nacl-hp34s2h0xx1ht4nwo****
ListenerId	string	The listener ID.	lsr-bp1bpn0kn908w4nbw****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	NotExist.Listener	listener %s is not exist	The listener %s does not exist.
400	NotActive.Listener	listener %s is not active	The listener %s is unavailable.
400	NotExist.Accelerator	accelerator %s is not exist	The GA instance %s does not exist.
400	StateError.Accelerator	accelerator state %s is illegal	The GA instance is in an invalid state %s.
400	NotExist.Acl	acl %s is not exist	The ACL %s does not exist.
400	StateError.Acl	acl state %s is illegal	The status of the ACL %s is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.