All Products
Search
Document Center

Server Load Balancer:AddEntriesToAcl

Last Updated:Sep 11, 2024

Adds IP entries to an access control list (ACL).

Operation description

  • Each ACL can contain IP addresses or CIDR blocks. Take note of the following limits on ACLs:

    • The maximum number of IP entries that can be added to an ACL with each Alibaba Cloud account at a time: 20
    • The maximum number of IP entries that each ACL can contain: 1,000
  • 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 ListAclEntries operation to query the status of the task.

    • If the ACL is in the Adding state, the IP entries are being added.
    • If the ACL is in the Available state, the IP entries are added.

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

Request parameters

ParameterTypeRequiredDescriptionExample
AclIdstringYes

The ID of the ACL.

nacl-hp34s2h0xx1ht4nwo****
AclEntriesarray<object>Yes

The ACL entries that you want to add. You can add at most 20 entries in each call.

objectYes

The ACL entry.

DescriptionstringNo

The description of the ACL entry. The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).

You can add at most 20 entries in each call.

test-entry
EntrystringYes

The CIDR block in the ACL entry.

10.0.1.0/24
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 only 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.

JobIdstring

The asynchronous task ID.

72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

Error codes

HTTP status codeError codeError messageDescription
400ResourceAlreadyExist.AclEntryThe specified resource %s already exists.The specified resource %s already exists.
400ResourceQuotaExceeded.AclEntriesNumThe quota of %s is exceeded for resource %s, usage %s/%s.-
400IncorrectStatus.AclThe status of %s [%s] is incorrect.The status of %s [%s] is incorrect.
400ResourceQuotaExceeded.ListenerAclEntriesNumThe quota of %s is exceeded for resource %s, usage %s/%s.The quota of %s is exceeded for resource %s, usage %s/%s.
400ResourceQuotaExceeded.LoadBalancerAclEntriesNumThe quota of %s is exceeded for resource %s, usage %s/%s.The quota of %s is exceeded for resource %s, usage %s/%s.
404ResourceNotFound.AclThe specified resource %s is not found.The specified resource %s is not found.

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

Change history

Change timeSummary of changesOperation
2024-01-24The Error code has changedView Change Details
2024-01-23The Error code has changedView Change Details