Global Accelerator:AddEntriesToAcl - Global Accelerator - Alibaba Cloud - Global Accelerator

Adds IP entries to an access control policy group and allows or restricts the forwarding of access requests to listeners for these IP entries by using Settings such as whitelists or blacklists, enabling precise control over client requests. You can call the AddEntriesToAcl operation to add IP entries to an access control policy group.

Operation description

AddEntriesToAcl is an asynchronous operation. After a request is sent, the system returns a request ID, but the IP entries are not yet added. The addition node continues in the background. You can call GetAcl or ListAcls to query the status of the access control policy group:
- If the access control policy group is in the configuring state, the IP entries are being added. In this state, you can only perform query operations and cannot perform other operations.
- If the access control policy group is in the active state, the IP entries are added.
You cannot concurrently call AddEntriesToAcl to add IP entries to an access control policy group within the same 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:AddEntriesToAcl

update

*Acl

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
AclId	string	Yes	The ID of the access control policy group.	nacl-hp34s2h0xx1ht4nwo****
AclEntries	array<object>	Yes	The access control policy group entries to add. An entry can be an IP address or a CIDR block. You can add up to 50 entries at a time.
	object	No	The access control policy group entries to add. An entry can be an IP address or a CIDR block. You can add up to 50 entries at a time.
Entry	string	No	The access control policy group entry to add. An entry can be an IP address or a CIDR block. You can add up to 50 entries at a time. Note This parameter is required.	10.0.XX.XX/24
EntryDescription	string	No	The description of the access control policy group entry. You can add descriptions for up to 50 entries at a time. The description must be 1 to 256 characters in length and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_). Chinese characters are supported.	test-entry
ClientToken	string	No	The client token that is used to ensure the idempotence of a 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.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request format, and business limitations without actually adding IP entries to the access control policy group. If the check fails, the corresponding error is returned. If the check succeeds, the `DryRunOperation` error code is returned. false (default): sends a normal request. If the check succeeds, 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.	365F4154-92F6-4AE4-92F8-7FF34B540710
AclId	string	The ID of the access control policy group.	nacl-hp34s2h0xx1ht4nwo****

Examples

Success response

JSON format

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "AclId": "nacl-hp34s2h0xx1ht4nwo****"
}

Error codes

HTTP status code	Error code	Error message	Description
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.
400	IsExist.AclEntriesIsExist	acl entries %s is exist	The ACL entry %s already exists.
400	QuotaExceeded.AclEntries	The number of acl entries exceeds the limit	The number of entries in the ACL exceeds the upper limit.
400	Repeat.AclEntries	acl entries repeat	ACL entries are duplicate.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.