Queries the 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.

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.

AclNames Array of String No test-acl

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

ResourceGroupId String No rg-atstuj3rtopty****

The ID of the resource group. You can filter the query results based on the specified ID.

NextToken String No caeba0bbb2be03f84eb48b699f0a****

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

MaxResults Integer No 50

The maximum number of ACLs to return. This parameter is optional. Valid values: 1 to 100. Default value: 20.

Response parameters

Parameter Type Example Description
Acls Array of Acl

The ACLs.

AclId String nacl-hp34s2h0xx1ht4nwo****

The ID of the ACL.

AclName String test-acl

The name of the ACL.

AclStatus String Available

The status of the ACL. Valid values:

  • Creating: The ACL is being created.
  • Available: The ACL is available.
  • Configuring: The ACL is being configured.
AddressIPVersion String IPv4

The IP version of the ACL. The value is fixed to IPv4.

ResourceGroupId String rg-atstuj3rtopty****

The ID of the resource group.

MaxResults Integer 5

The maximum number of ACLs returned. This parameter is optional. Valid values: 1 to 100. Default value: 20.

NextToken String FFmyTO70t****

The end position of the query. If the response does not contain this parameter, all data has been queried.

RequestId String 593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3

The ID of the request.

TotalCount Integer 10

The total number of ACLs returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListAcls
&AclIds=["nacl-hp34s2h0xx1ht4nwo****"]
&AclNames=["test-acl"]
&ResourceGroupId=rg-atstuj3rtopty****
&NextToken=caeba0bbb2be03f84eb48b699f0a****
&MaxResults=50
&<Common request parameters>

Sample success responses

XML format

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

<ListAclsResponse>
    <Acls>
        <AclId>nacl-hp34s2h0xx1ht4nwo****</AclId>
        <AclName>test-acl</AclName>
        <AclStatus>Available</AclStatus>
        <AddressIPVersion>IPv4</AddressIPVersion>
        <ResourceGroupId>rg-atstuj3rtopty****</ResourceGroupId>
    </Acls>
    <MaxResults>5</MaxResults>
    <NextToken>FFmyTO70t****</NextToken>
    <RequestId>593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3</RequestId>
    <TotalCount>10</TotalCount>
</ListAclsResponse>

JSON format

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

{
  "Acls" : [ {
    "AclId" : "nacl-hp34s2h0xx1ht4nwo****",
    "AclName" : "test-acl",
    "AclStatus" : "Available",
    "AddressIPVersion" : "IPv4",
    "ResourceGroupId" : "rg-atstuj3rtopty****"
  } ],
  "MaxResults" : 5,
  "NextToken" : "FFmyTO70t****",
  "RequestId" : "593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3",
  "TotalCount" : 10
}

Error codes

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