Creates an access control list (ACL).

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 a 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 (.), hyphens (-) and underscores (_). It must start with a letter.

AddressIPVersion String Yes IPv4

The IP version. Valid values: ipv4 and ipv6.

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 ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

If you do not specify this parameter, the system automatically uses the request ID as the client token. The ID of each request may be different.

DryRun Boolean No true

Specifies whether to precheck this request. Valid values:

  • true: prechecks the request. Resources are not created. The system checks the required parameters, request format, and service limits. If the request fails the precheck, an error code is returned based on the cause of failure. If the request passes the precheck, the DryRunOperation error code is returned.
  • false: sends the request. This is the default value. If the request passes the precheck, a 2XX HTTP status code is returned and the operation is performed.
AclEntries.N.Entry String No 10.0.1.1/24

The IP entry that you want to add to the ACL.

AclEntries.N.EntryDescription String No test-entry

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

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/IPv6
&AclEntries=[{"Entry":"10.0.1.1/24","EntryDescription":"test-entry"}]
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&DryRun=true
&<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.