All Products
Search
Document Center

Global Accelerator:AddEntriesToAcl

Last Updated:Mar 29, 2024

Adds IP addresses or CIDR blocks to an access control list (ACL). You can add IP addresses or CIDR blocks to an ACL and configure a whitelist or blacklist to allow or deny requests from clients.

Operation description

  • AddEntriesToAcl 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 GetAcl or ListAcls operation to query the status of the ACL to which you want to add IP entries.

    • If the ACL is in the configuring state, it indicates that IP entries are added to the ACL. In this case, you can perform only query operations.
    • If the ACL is in the active state, it indicates that IP entries are added to the ACL.
  • The AddEntriesToAcl operation holds an exclusive lock on the Global Accelerator (GA) instance. While the operation is in progress, you cannot call the same operation in the same Alibaba Cloud account.

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:AddEntriesToAclWrite
  • Acl
    acs:ga:{#regionId}:{#accountId}:acl/{#aclId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the GA instance. Set the value to cn-hangzhou.

cn-hangzhou
AclIdstringYes

The ACL ID.

nacl-hp34s2h0xx1ht4nwo****
AclEntriesobject []Yes

The IP addresses or CIDR blocks that you want to add to the ACL. You can add at most 20 entries in each request.

EntrystringNo

The IP address (192.168.XX.XX) or CIDR block (10.0.XX.XX/24) that you want to add to the ACL. You can add at most 20 entries in each request.

Note This parameter is required.
10.0.XX.XX/24
EntryDescriptionstringNo

The description of the entry.

You can add the descriptions of up to 20 entries in each request.

The description must be 1 to 256 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_).

test-entry
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
DryRunbooleanNo

Specifies whether to perform 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.
false

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

365F4154-92F6-4AE4-92F8-7FF34B540710
AclIdstring

The ACL ID.

nacl-hp34s2h0xx1ht4nwo****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400NotExist.Aclacl %s is not existThe ACL %s does not exist.
400StateError.Aclacl state %s is illegalThe status of the ACL %s is invalid.
400IsExist.AclEntriesIsExistacl entries %s is existThe ACL entry %s already exists.
400QuotaExceeded.AclEntriesThe number of acl entries exceeds the limitThe number of entries in the ACL exceeds the upper limit.
400Repeat.AclEntriesacl entries repeatACL entries are duplicate.

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

Change history

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