Query access control lists using DescribeAccessControlLists - API Gateway - Alibaba Cloud - API Gateway

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

apigateway:DescribeAccessControlLists

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AclName	string	No	The name of the access control policy.	testAcl
PageSize	integer	No	The number of entries to return on each page.	10
PageNumber	integer	No	The page number of the current page.	1
AddressIPVersion	string	No	IP Version,You can set it to ipv4 or ipv6.	ipv6

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number of the current page.	1
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of entries returned.	3
Acls	object
Acl	array<object>	The ACLs.
	object	The ACL.
AclName	string	The name of the access control policy.	testAcl
AclId	string	The ID of the access control policy.	acl-3nsohdozz0ru8fi5onwz1
AddressIPVersion	string	of the access control policy group IP Version. IPv4. IPv6.	ipv4

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "PageSize": 10,
  "TotalCount": 3,
  "Acls": {
    "Acl": [
      {
        "AclName": "testAcl",
        "AclId": "acl-3nsohdozz0ru8fi5onwz1",
        "AddressIPVersion": "ipv4"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.