DescribeACLAttribute - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries the information about 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:DescribeACLAttribute	Read	Acl acs:smartag:{#regionId}:{#accountId}:acl/{#AclId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the ACL is deployed.	cn-hangzhou
AclId	string	Yes	The ID of the ACL.	acl-ohlexqptfhyaq****
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
Direction	string	No	The direction of traffic in which the ACL rule is applied. Valid values: in: The ACL rule controls inbound network traffic of the on-premises network that is associated with the Smart Access Gateway (SAG) instance. out: The ACL rule controls outbound network traffic of the on-premises network that is associated with the SAG instance.	out
Order	string	No	The ID of the order.	1255444444
Name	string	No	The name of the ACL. The name must be 2 to 100 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter. Note This parameter supports fuzzy match.	doctest

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	3
PageSize	integer	The number of entries to return on each page.	10
RequestId	string	The ID of the request.	8F62CE77-FBA2-4F8D-AED9-0A02814EDA69
PageNumber	integer	The page number of the returned page.	1
Acrs	object []	The information about the ACL rules in the ACL.
Direction	string	The direction of traffic in which the ACL rule is applied. in: The ACL rule controls inbound network traffic of the on-premises network that is associated with the SAG instance. out: The ACL rule controls outbound network traffic of the on-premises network that is associated with the SAG instance.	out
Type	string	The type of the ACL rule: LAN: The ACL rule controls network traffic transmitted through private IP addresses. WAN: The ACL rule controls network traffic transmitted through public IP addresses.	WAN
DpiSignatureIds	array	The IDs of the applications that match the current ACL rule. You can call the ListDpiSignatures operation to query application IDs and information about the applications.
	string		1
IpProtocol	string	The protocol used by the ACL rule. The supported protocols provided in this topic are for reference only. The actual protocols in the SAG console shall prevail. The value of the parameter is not case-sensitive.	UDP
Priority	integer	The priority of the ACL rule. Valid values: 1 to 100.	70
AclId	string	The ID of ACL.	acl-7louazbja80bmg****
Policy	string	The action of the ACL rule. Valid values: accept: allows network traffic. drop: blocks network traffic.	drop
Description	string	The description of the ACL rule. The description must be 1 to 512 characters in length. By default, this parameter is not returned. You can call the ModifyACLRule operation to add a description for the ACL rule. Then, this parameter is included in the response.
GmtCreate	long	The timestamp when the ACL rule was created. The timestamp is of the Long data type. If multiple ACL rules have the same priority, the rule with the earliest timestamp takes effect.	1580821597000
DestCidr	string	The destination CIDR block. The value of this parameter is specified in CIDR notation. Example: 192.168.10.0/24.	0.0.0.0/0
DestPortRange	string	The destination port range. Valid values: 1 to 65535 and -1. The destination port range is in one of the following formats: 1/200 or 80/80. A value of -1/-1 indicates all ports.	10000/20000
Name	string	The name of the ACL. The name must be 2 to 100 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.	doctest
AcrId	string	The ID of the ACL rule.	acr-gxzxj5w9qqdf1c****
SourceCidr	string	The source CIDR block. The value of this parameter in is specified in CIDR notation. Example: 192.168.1.0/24.	0.0.0.0/0
SourcePortRange	string	The source port range. Valid values: 1 to 65535 and -1. The source port range is in one of the following formats: 1/200 or 80/80. A value of -1/-1 indicates all ports.	30000/40000
DpiGroupIds	array	The IDs of the application groups that match the current ACL rule. You can call the ListDpiGroups operation to query application group IDs and information about the applications.
	string		20
AclType	string	The number of SAG instances associated with the ACL. Valid values: acl-hardware: SAG CPE instance acl-software: SAG app instance	acl-hardware

Examples

Sample success responses

JSONformat

{
  "TotalCount": 3,
  "PageSize": 10,
  "RequestId": "8F62CE77-FBA2-4F8D-AED9-0A02814EDA69",
  "PageNumber": 1,
  "Acrs": {
    "Acr": [
      {
        "Direction": "out",
        "Type": "WAN",
        "DpiSignatureIds": {
          "DpiSignatureId": [
            "1"
          ]
        },
        "IpProtocol": "UDP",
        "Priority": 70,
        "AclId": "acl-7louazbja80bmg****",
        "Policy": "drop",
        "Description": "",
        "GmtCreate": 1580821597000,
        "DestCidr": "0.0.0.0/0",
        "DestPortRange": "10000/20000",
        "Name": "doctest",
        "AcrId": "acr-gxzxj5w9qqdf1c****",
        "SourceCidr": "0.0.0.0/0",
        "SourcePortRange": "30000/40000",
        "DpiGroupIds": {
          "DpiGroupId": [
            "20"
          ]
        },
        "AclType": "acl-hardware"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.	You do not have permissions to manage the specified resource.
403	MissingParameter	The input parameter is missing, please check your input.	Missing parameters. Check whether all required parameters are set.
403	InvalidParameter	The specified parameter is invalid.	Invalid parameters.
403	InvalidId.ACL	The specified ACL ID is invalid.	The specified ACL group ID is invalid.
403	InternalError	An internal server error occurred.	An internal server error occurred.

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

Change history

Change time

Summary of changes

Operation

2022-09-06

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 403
Output Parameters	The response structure of the API has changed.