All Products
Search
Document Center

Global Accelerator:GetAcl

Last Updated:May 16, 2024

Queries an access control list (ACL).

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:GetAclRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
AclIdstringYes

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

nacl-hp34s2h0xx1ht4nwo****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the network ACL.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
AclIdstring

The ID of the request.

nacl-hp34s2h0xx1ht4nwo****
AddressIPVersionstring

The ID of the network ACL.

IPv4
AclStatusstring

The IP version of the network ACL. Valid values:

  • IPv4
  • IPv6
active
AclEntriesobject []

The entries of the ACL.

Entrystring

An IP address entry (192.168.XX.XX) or a CIDR block entry (10.0.XX.XX/24).

10.0.XX.XX/24
EntryDescriptionstring

The description of the ACL entry.

test-entry
RelatedListenersobject []

The listeners that are associated with the ACL.

ListenerIdstring

The ID of the listener.

lsr-bp1bpn0kn908w4nbw****
AclTypestring

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 a whitelist is enabled but no IP address is added to the whitelist, the listener forwards all requests.
  • black: All requests from the IP addresses or CIDR blocks in the ACL are rejected. Blacklists are suitable for scenarios in which you want to deny access from specific IP addresses to an application. If a blacklist is enabled but no IP address is added to the blacklist, the listener forwards all requests.
White
AcceleratorIdstring

The ID of the GA instance.

ga-bp1odcab8tmno0hdq****
AclNamestring

The ID of the GA instance.

test-acl
ResourceGroupIdstring

The name of the network ACL.

rg-acfmx7itmygzsza
Tagsobject []

The tag of the ACL.

Keystring

The key of tag N that is add to the ACL.

tag-key
Valuestring

The value of tag N that is add to the ACL.

tag-value

Examples

Sample success responses

JSONformat

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

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

Change history

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