Creates an access control list (ACL).

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateAcl

The operation that you want to perform. Set the value to CreateAcl.

RegionId String Yes cn-hangzhou

The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.

AclName String No test-acl

The name of the ACL. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.

AddressIPVersion String Yes IPv4

The IP version of the ACL. Valid values:

  • IPv4
  • IPv6
AclEntries.N.Entry String No 10.0.XX.XX/24

The IP address or CIDR block that you want to add to the ACL.

You can add up to 20 entries in each request.

AclEntries.N.EntryDescription String No test-entry

The description of the entry that you want to add to the ACL.

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 (_).

ClientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId may be different for each API request.
DryRun Boolean No false

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.

Response parameters

Parameter Type Example Description
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

The ID of the request.

AclId String nacl-hp34s2h0xx1ht4nwo****

The ID of the ACL.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateAcl
&RegionId=cn-hangzhou
&AclName=test-acl
&AddressIPVersion=IPv4
&AclEntries=[{"Entry":"10.0.XX.XX/24","EntryDescription":"test-entry"}]
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&DryRun=false
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateAclResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <AclId>nacl-hp34s2h0xx1ht4nwo****</AclId>
</CreateAclResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.