Queries access control lists (ACLs) of a region.

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 ListAcls

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

RegionId String Yes cn-hangzhou

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

ClientToken String No 02fb3da4****

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 only contain ASCII characters, and cannot exceed 64 characters in length.

AclIds Array of String No nacl-hp34s2h0xx1ht4nwo****

The IDs of the ACLs that you want to query. You can specify up to 20 IDs at a time.

AclName String No test-acl

The name of the ACL. You can specify up to 10 names at a time.

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

NextToken String No caeba0bbb2be03f84eb48b699f0a****

The position from which the query starts. If this parameter is left empty, the query starts from the beginning.

MaxResults Integer No 50

The maximum number of ACLs to return. The parameter is optional. Valid values: 1 to 100. If this parameter is left empty, the default value 20 is returned.

Response parameters

Parameter Type Example Description
RequestId String 64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF

The ID of the request.

TotalCount Integer 10

The total number of ACLs returned.

NextToken String FFmyTO70t****

The position from which the query starts. If no value is returned, the query starts from the beginning.

MaxResults Integer 5

The maximum number of entries returned. Valid values: 1 to 100. If this parameter is left empty, the default value 20 is returned.

Acls Array of Acls

The ACLs.

AclId String nacl-hp34s2h0xx1ht4nwo****

The ID of the ACL.

AclName String test-acl

The name of the ACL.

AddressIPVersion String IPv4

The IP version of the ACL. Valid value: IPv4.

AclStatus String Available

The state of the ACL. Valid values:

  • Provisioning: The ACL is being created.
  • Available: The ACL is available.
  • Configuring: The ACL is being configured.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListAcls
&RegionId=cn-hangzhou
&ClientToken=02fb3da4****
&AclIds=["nacl-hp34s2h0xx1ht4nwo****"]
&AclName=test-acl
&NextToken=caeba0bbb2be03f84eb48b699f0a****
&MaxResults=50
&<Common request parameters>

Sample success responses

XML format 

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

<ListAclsResponse>
    <RequestId>64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF</RequestId>
    <TotalCount>10</TotalCount>
    <NextToken>FFmyTO70t****</NextToken>
    <MaxResults>5</MaxResults>
    <Acls>
        <AclId>nacl-hp34s2h0xx1ht4nwo****</AclId>
        <AclName>test-acl</AclName>
        <AddressIPVersion>IPv4</AddressIPVersion>
        <AclStatus>Available</AclStatus>
    </Acls>
</ListAclsResponse>

JSON format 

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

{
  "RequestId" : "64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF",
  "TotalCount" : 10,
  "NextToken" : "FFmyTO70t****",
  "MaxResults" : 5,
  "Acls" : [ {
    "AclId" : "nacl-hp34s2h0xx1ht4nwo****",
    "AclName" : "test-acl",
    "AddressIPVersion" : "IPv4",
    "AclStatus" : "Available"
  } ]
}

Error codes

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