All Products
Search
Document Center

Global Accelerator:ListAcls

Last Updated:May 16, 2024

Queries a list of access control lists (ACLs).

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
ga:ListAclsList
  • Acl
    acs:ga:{#regionId}:{#accountId}:acl/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ClientTokenstringNo

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.
123e4567-e89b-12d3-a456-426655440000
AclIdsarrayNo

The ACL IDs. You can specify a maximum of 20 ACL IDs in each request.

stringNo

The ACL ID. You can specify a maximum of 20 ACL IDs in each request.

nacl-hp34s2h0xx1ht4nwo****
AclNamestringNo

The ACL name. You can specify a maximum of ACL names in each request.

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
NextTokenstringNo

The token that is used for the next query. Valid values:

  • If this is your first and only query, ignore this parameter.
  • If a subsequent query is to be performed, set the parameter to the value of NextToken that is returned from the last call.
caeba0bbb2be03f84eb48b699f0a****
MaxResultsintegerNo

The number of entries per page. Valid values: 1 to 50. Default value: 10.

10
ResourceGroupIdstringNo

The ID of the resource group.

rg-aek2lgw4evw****
Tagobject []No

The tag of the ACL.

KeystringNo

The tag key of the ACL. The value of this parameter cannot be an empty string.

The tag key can be up to 64 characters in length, and cannot contain http:// or https://. The tag key cannot start with aliyun or acs:.

You can specify a maximum of 20 tag keys.

tag-key
ValuestringNo

The tag value of the ACL. The tag value can be an empty string.

The tag value can be up to 128 characters in length, and cannot contain http:// or https://. The tag value cannot start with aliyun or acs:.

You can specify a maximum of 20 tag values.

tag-value

Response parameters

ParameterTypeDescriptionExample
object

The returned information.

RequestIdstring

The ID of the request.

64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
TotalCountinteger

The total number of entries returned.

1
NextTokenstring

The token that is used for the next query. Valid values:

  • If NextToken is not returned, it indicates that no additional results exist.
  • If NextToken is returned, the value is the token that is used for the next query.
FFmyTO70t****
MaxResultsinteger

The number of entries returned per page.

10
Aclsobject []

The network ACLs.

AclIdstring

The ID of the network ACL.

nacl-hp34s2h0xx1ht4nwo****
AclNamestring

The name of the network ACL.

test-acl
AddressIPVersionstring

The IP version of the network ACL. Valid values:

  • IPv4
  • IPv6
IPv4
AclStatusstring

The status of the network ACL. Valid values:

  • init: The network ACL is being initialized.
  • active: The network ACL is available.
  • configuring: The network ACL is being configured.
  • updating: The network ACL is being updated.
  • deleting: The network ACL is being deleted.
active
ResourceGroupIdstring

The ID of the resource group.

rg-aek2lgw4evw****
Tagsobject []

The tags of the network ACL.

Keystring

The tag key of the network ACL.

tag-key
Valuestring

The tag value of the network ACL.

tag-value

Examples

Sample success responses

JSONformat

{
  "RequestId": "64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF",
  "TotalCount": 1,
  "NextToken": "FFmyTO70t****",
  "MaxResults": 10,
  "Acls": [
    {
      "AclId": "nacl-hp34s2h0xx1ht4nwo****",
      "AclName": "test-acl",
      "AddressIPVersion": "IPv4",
      "AclStatus": "active",
      "ResourceGroupId": "rg-aek2lgw4evw****",
      "Tags": [
        {
          "Key": "tag-key",
          "Value": "tag-value"
        }
      ]
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2021-04-27Add Operationsee changesets