Query access control lists with ListAcls - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries access control lists (ACLs).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ga:ListAcls

list

*Acl

acs:ga:{#regionId}:{#accountId}:acl/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of a request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId value as the ClientToken value. The RequestId value of each API request is different.	123e4567-e89b-12d3-a456-426655440000
AclIds	array	No	The IDs of the access control policy groups. You can specify up to 10 access control policy group IDs at a time.
	string	No	The ID of the access control policy group. You can specify up to 10 access control policy group IDs at a time.	nacl-hp34s2h0xx1ht4nwo****
AclName	string	No	The name of the access control policy group. You can specify up to 10 access control policy group names at a time. The name must be 1 to 128 characters in length and must start with a letter or a Chinese character. The name can contain digits, periods (.), underscores (_), and hyphens (-).	test-acl
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request or if no next query is to be sent. If a next query is to be sent, set the value to the NextToken value returned in the last API call.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	The number of entries per page for paging. Valid values: 1 to 50. Default value: 10.	10
ResourceGroupId	string	No	The resource group ID.	rg-aek2lgw4evw****
Tag	array<object>	No	The tags of the access control policy group.
	object	No	The tags of the access control policy group.
Key	string	No	The tag key of the access control policy group. If you specify this parameter, the value cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag keys.	tag-key
Value	string	No	The tag value of the access control policy group. If you specify this parameter, the value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag values.	tag-value

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
TotalCount	integer	The total number of entries returned.	1
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next query is to be sent. If a value of NextToken is returned, the value indicates the token that is used for the next query.	FFmyTO70t****
MaxResults	integer	The number of entries per page for paging.	10
Acls	array<object>	The list of access control policy groups.
	array<object>	The access control policy group.
AclId	string	The ID of the access control policy group.	nacl-hp34s2h0xx1ht4nwo****
AclName	string	The name of the access control policy group.	test-acl
AddressIPVersion	string	The IP version of the access control policy group. Valid values: IPv4 IPv6	IPv4
AclStatus	string	The status of the access control policy group. Valid values: init: initialization. active: available. configuring: being configured. updating: being updated. deleting: being deleted.	active
ResourceGroupId	string	The resource group ID.	rg-aek2lgw4evw****
Tags	array<object>	The tags of the access control policy group.
	object	The tag of the access control policy group.
Key	string	The tag key of the access control policy group.	tag-key
Value	string	The tag value of the access control policy group.	tag-value

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.