CreateAcl - Global Accelerator - Alibaba Cloud Documentation Center

Creates an access control list (ACL).

Operation description

CreateAcl 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 GetAcl or ListAcls operation to query the state of an ACL.

If the ACL is in the init state, the ACL is being created. In this case, you can only perform only query operations.
If the ACL is in the active state, the ACL is created.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ga:CreateAcl	create	Acl acs:ga:{#regionId}:{#accountId}:acl/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
AclName	string	No	The ACL name. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.	test-acl
AddressIPVersion	string	Yes	The IP version of the ACL. Valid values: IPv4 IPv6	IPv4
AclEntries	array<object>	No	The entries of IP addresses or CIDR blocks to add to the ACL. You can add a maximum of 50 entries at a time.
	object	No	The ACL entries.
Entry	string	No	The IP addresses (192.168.XX.XX) or CIDR blocks (10.0.XX.XX/24) that you want to add to the ACL. You can add a maximum of 50 entries at a time.	10.0.XX.XX/24
EntryDescription	string	No	The description of the entry that you want to add to the ACL. You can add a maximum of 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 (_).	test-entry
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 request ID as the client token. The request ID may be different for each request.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	No	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
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmwj7wvng3jbi
Tag	array<object>	No	The tags of the ACL.
	object	No	The tags of the ACL.
Key	string	No	The tag key of the ACL. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`. You can specify up to 20 tag keys.	tag-key
Value	string	No	The tag value of the ACL. The tag value cannot be an empty string. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`. You can specify up to 20 tag values.	tag-value

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
AclId	string	The ID of the ACL.	nacl-hp34s2h0xx1ht4nwo****

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "AclId": "nacl-hp34s2h0xx1ht4nwo****"
}

Error codes

HTTP status code	Error code	Error message	Description
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.

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

Change history

Change time	Summary of changes	Operation
2023-04-20	The Error code has changed	View Change Details
2023-03-31	The Error code has changed. The request parameters of the API has changed	View Change Details
2021-04-27	Add Operation	View Change Details