All Products
Search
Document Center

API Gateway:DescribeAccessControlLists

Last Updated:Jul 31, 2025

This feature provides instance-level access control for dedicated instances. Queries access control policies.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
apigateway:DescribeAccessControlListsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AclNamestringNo

The name of the access control policy.

testAcl
PageSizeintegerNo

The number of entries to return on each page.

10
PageNumberintegerNo

The page number of the current page.

1
AddressIPVersionstringNo

IP 版本,可以设置为 ipv4 或者 ipv6

ipv6

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the current page.

1
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
PageSizeinteger

The number of entries returned on each page.

10
TotalCountinteger

The total number of entries returned.

3
Aclsarray<object>

The ACLs.

Aclobject

The ACL.

AclNamestring

The name of the access control policy.

testAcl
AclIdstring

The ID of the access control policy.

acl-3nsohdozz0ru8fi5onwz1
AddressIPVersionstring

访问控制策略组的 IP 版本。

  • IPv4
  • IPv6
ipv4

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history