All Products
Search
Document Center

Server Load Balancer:DescribeAccessControlListAttribute

Last Updated:Mar 14, 2024

Queries the configuration of 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
slb:DescribeAccessControlListAttributeREAD
  • acl
    acs:slb:{#regionId}:{#accountId}:acl/{#aclId}
  • slb:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The time when the network ACL was created. The time follows the YYYY-MM-DDThh:mm:ssZ format.

cn-hangzhou
AclIdstringYes

The ID of the ACL.

acl-bp1l0k********kzet04s
AclEntryCommentstringNo

The remarks of the ACL entry.

It must be 2 to 100 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.

test
PageintegerNo

The page number.

1
PageSizeintegerNo

The number of entries returned on each page. Maximum value: 50. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
AclIdstring

The ID of the network ACL.

acl-bp1l0k********kzet04s
Tagsobject []

The tags.

TagKeystring

The tag key.

TestKey
TagValuestring

The tag value.

TestValue
AddressIPVersionstring

The IP version. Valid values: ipv4 and ipv6.

ipv4
RequestIdstring

The ID of the request.

C9906A1D-86F7-4C9C-A369-54DA42EF206A
ResourceGroupIdstring

The resource group ID.

rg-******************
AclNamestring

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.

doctest
AclEntrysobject []

The IP entries that you want to remove from the network ACL. Valid values:

  • entry: the IP address or CIDR block that you want to remove from the network ACL. Separate multiple IP addresses or CIDR blocks with commas (,).
  • comment: the description of the network ACL.
AclEntryCommentstring

The description of the ACL entry.

test
AclEntryIPstring

The IP address specified in the ACL entry.

192.168.0.1
RelatedListenersobject []

The listeners that are associated with the network ACL.

ListenerPortinteger

The frontend port of the listener with which the ACL is associated.

443
AclTypestring

The type of ACL. Valid values:

  • black
  • white
white
Protocolstring

The type of protocol that the associated listener uses.

https
LoadBalancerIdstring

The CLB instance ID.

lb-bp13j********1miup
CreateTimestring

The time when the ACL was created. The time follows the YYYY-MM-DDThh:mm:ssZ format.

2022-08-31T02:49:05Z
TotalAclEntryinteger

The total number of access control entries.

200

Examples

Sample success responses

JSONformat

{
  "AclId": "acl-bp1l0k********kzet04s",
  "Tags": {
    "Tag": [
      {
        "TagKey": "TestKey",
        "TagValue": "TestValue"
      }
    ]
  },
  "AddressIPVersion": "ipv4",
  "RequestId": "C9906A1D-86F7-4C9C-A369-54DA42EF206A",
  "ResourceGroupId": "rg-******************",
  "AclName": "doctest",
  "AclEntrys": {
    "AclEntry": [
      {
        "AclEntryComment": "test",
        "AclEntryIP": "192.168.0.1"
      }
    ]
  },
  "RelatedListeners": {
    "RelatedListener": [
      {
        "ListenerPort": 443,
        "AclType": "white",
        "Protocol": "https",
        "LoadBalancerId": "lb-bp13j********1miup"
      }
    ]
  },
  "CreateTime": "2022-08-31T02:49:05Z",
  "TotalAclEntry": 200
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-03-21The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Page
    Added Input Parameters: PageSize
Output ParametersThe response structure of the API has changed.