Use GetAcl to query an access control list - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries an access control list (ACL).

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:GetAcl

get

*Acl

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The operation that you want to perform. Set the value to GetAcl.	cn-hangzhou
AclId	string	Yes	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	nacl-hp34s2h0xx1ht4nwo****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the network ACL.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
AclId	string	The ID of the request.	nacl-hp34s2h0xx1ht4nwo****
AddressIPVersion	string	The ID of the network ACL.	IPv4
AclStatus	string	The IP version of the network ACL. Valid values: IPv4 IPv6	active
AclEntries	array<object>	The entries of the ACL.
	object	The network ACL entries. Up to 20 entries are returned.
Entry	string	An IP address entry (192.168.XX.XX) or a CIDR block entry (10.0.XX.XX/24).	10.0.XX.XX/24
EntryDescription	string	The description of the ACL entry.	test-entry
RelatedListeners	array<object>	The listeners that are associated with the ACL.
	object	The listeners that are associated with the network ACL.
ListenerId	string	The ID of the listener.	lsr-bp1bpn0kn908w4nbw****
AclType	string	The type of the ACL. Valid values: white: Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists are suitable for scenarios in which you want to allow access from specific IP addresses to an application. If a whitelist is improperly configured, risks may arise. After a whitelist is configured for a listener, only requests from the IP addresses that are added to the whitelist are distributed by the listener. If the whitelist is empty, the listener forwards all requests. black: All requests from the IP addresses or CIDR blocks in the ACL are denied. If the blacklist is empty, the listener forwards all requests.	White
AcceleratorId	string	The ID of the GA instance.	ga-bp1odcab8tmno0hdq****
AclName	string	The ID of the GA instance.	test-acl
ResourceGroupId	string	The name of the network ACL.	rg-acfmx7itmygzsza
Tags	array<object>	The tag of the ACL.
	object	The tag value.
Key	string	The tag key.	tag-key
Value	string	The tag value.	tag-value

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "AclId": "nacl-hp34s2h0xx1ht4nwo****",
  "AddressIPVersion": "IPv4",
  "AclStatus": "active",
  "AclEntries": [
    {
      "Entry": "10.0.XX.XX/24",
      "EntryDescription": "test-entry"
    }
  ],
  "RelatedListeners": [
    {
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "AclType": "white",
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****"
    }
  ],
  "AclName": "test-acl",
  "ResourceGroupId": "rg-acfmx7itmygzsza",
  "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.