DescribeAccessControlLists for querying access control lists - Server Load Balancer

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

slb:DescribeAccessControlLists

list

AccessControlList

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

slb:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the ACL. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
AclName	string	No	The ACL name. The ACL name. The name must be 1 to 80 characters in length, and can contain letters, digits, periods (.), hyphens (-), forward slashes (/), and underscores (_). The name of each ACL must be unique within a region. Fuzzy match is supported.	rule1
AddressIPVersion	string	No	The IP version of the Classic Load Balancer (CLB) instance with which the ACL is associated. Valid values: ipv4 ipv6	ipv4
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
ResourceGroupId	string	No	The resource group ID.	rg-atstuj3rtop4****
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The key of the tag. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key must be 1 to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	test
Value	string	No	The tag value. You can specify at most 20 tag values. The tag value cannot be an empty string. The tag value must be 1 to 128 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.	1

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The number of the returned page. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries returned on each page. Maximum value: 50. Default value: 10.	10
RequestId	string	The request ID.	3CB646EF-6147-4566-A9D9-CE8FBE86F971
TotalCount	integer	The total number of ACLs.	1
Count	integer	The number of ACLs on the current page.	1
Acls	object
Acl	array<object>	A list of ACLs.
	array<object>
AclId	string	The ACL ID.	acl-bp1l0kk4gxce43k*****
AddressIPVersion	string	The IP version that is used by the CLB instance associated with the ACL.	ipv4
AclName	string	The ACL name.	rule1
ResourceGroupId	string	The resource group ID.	rg-jfenfbp1lhl0****
Tags	object
Tag	array<object>	The list of tags added to the network ACL. The value of this parameter must be a STRING list in the JSON format.
	object		{"Key":"test","Value":"value"}
TagValue	string	The tag value.	1
TagKey	string	The tag key.	test
CreateTime	string	The time when the CLB instance was created. The time follows the `YYYY-MM-DDThh:mm:ssZ` format.	2022-08-31T02:49:05Z

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "3CB646EF-6147-4566-A9D9-CE8FBE86F971",
  "TotalCount": 1,
  "Count": 1,
  "Acls": {
    "Acl": [
      {
        "AclId": "acl-bp1l0kk4gxce43k*****",
        "AddressIPVersion": "ipv4",
        "AclName": "rule1",
        "ResourceGroupId": "rg-jfenfbp1lhl0****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "1",
              "TagKey": "test"
            }
          ]
        },
        "CreateTime": "2022-08-31T02:49:05Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidResourceGroupId.NotFound	The specified ResourceGroupId is not found.
400	LocationServiceTimeout	Location service connection timeout. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.