Use DescribeNetworkAcls to query network ACLs - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Queries a list of network ACLs by calling the DescribeNetworkAcls operation.

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

vpc:DescribeNetworkAcls

list

*NetworkAcl

acs:vpc:{#regionId}:{#accountId}:networkacl/*

None

Request parameters

Parameter	Type	Required	Description	Example
NetworkAclId	string	No	The ID of the network ACL.	nacl-bp1lhl0taikrbgnh****
NetworkAclName	string	No	The name of the network ACL. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.	acl-1
VpcId	string	No	The ID of the VPC associated with the network ACL.	vpc-m5ebpc2xh64mqm27e****
ResourceType	string	No	The type of the associated resource. Valid values: VSwitch: vSwitch. The ResourceType and ResourceId parameters must be specified together to take effect.	VSwitch
ResourceId	string	No	The ID of the associated resource.	vsw-bp1de348lntdwnhbg****
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page in a paged query. Maximum value: 50. Default value: 10.	10
RegionId	string	Yes	The region ID of the network ACL. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
Tags	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. A tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceJoshua
RegionId	string	Yes	The region ID of the network ACL. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object
PageSize	string	The number of entries per page in a paging query.	10
RequestId	string	The request ID.	F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1
PageNumber	string	The page number of the list.	1
TotalCount	string	The total number of network ACLs in the list.	2
NetworkAcls	object
NetworkAcl	array<object>	The details of the network ACL.
	array<object>	The details of the network ACL.
Status	string	The status of the network ACL. Valid values: Available Modifying	Available
VpcId	string	The ID of the associated VPC.	vpc-m5ebpc2xh64mqm27e****
CreationTime	string	The time when the network ACL was created.	2021-12-25 11:44:17
Description	string	The description of the network ACL.	This is my NetworkAcl.
NetworkAclName	string	The name of the network ACL.	acl-1
NetworkAclId	string	The ID of the network ACL.	nacl-a2do9e413e0spxscd****
OwnerId	integer	The ID of the Alibaba Cloud account to which the network ACL belongs.	253460731706911258
RegionId	string	The region ID of the network ACL.	cn-hangzhou
IngressAclEntries	object
IngressAclEntry	array<object>	The configurations of the inbound rules.
	object
NetworkAclEntryId	string	The ID of the inbound rule.	nae-a2dk86arlydmezasw****
EntryType	string	The type of the inbound rule. custom system	custom
NetworkAclEntryName	string	The name of the inbound rule.	acl-3
Policy	string	The action to be performed on network traffic that matches the rule. Valid values: accept drop	accept
Description	string	The description of the inbound rule.	This is IngressAclEntries.
SourceCidrIp	string	The source CIDR block.	10.0.0.0/24
IpVersion	string	The IP version. IPv4 IPv6	IPv4
Protocol	string	The protocol. Valid values: icmp gre tcp udp all	all
Port	string	The destination port range of the inbound traffic. If the protocol of the inbound rule is set to all, icmp, or gre, the port range is -1/-1, which specifies all ports. If the protocol of the inbound rule is set to tcp or udp, set the port range in the following format: 1/200 or 80/80, which specifies port 1 to port 200 or port 80. Valid ports: 1 to 65535.	-1/-1
EgressAclEntries	object
EgressAclEntry	array<object>	The outbound rules.
	object
NetworkAclEntryId	string	The ID of the outbound rule.	nae-a2d447uw4tillfvgb****
EntryType	string	The type of the inbound rule. custom system	custom
NetworkAclEntryName	string	The name of the outbound rule.	acl-2
Policy	string	The action to be performed on network traffic that matches the rule. Valid values: accept drop	accept
Description	string	The description of the outbound rule.	This is EgressAclEntries.
Protocol	string	The protocol. Valid values: icmp gre tcp udp all	all
DestinationCidrIp	string	The destination CIDR block.	10.0.0.0/24
IpVersion	string	The IP version. IPv4 IPv6	IPv4
Port	string	The destination port range of the outbound traffic. If the protocol of the outbound rule is set to all, icmp, or gre, the port range is -1/-1, which specified all ports. If the protocol of the outbound rule is set to tcp or udp, set the port range in the following format: 1/200 or 80/80, which specifies port 1 to port 200 or port 80. Valid values for a port: 1 to 65535.	-1/-1
Resources	object
Resource	array<object>	The resources that are associated with the network ACL.
	object
Status	string	The association status of the resource. Valid values: BINDED BINDING UNBINDING	BINDED
ResourceType	string	The type of resource with which you want to associate the network ACL.	VSwitch
ResourceId	string	The ID of the associated resource.	vsw-bp1de348lntdwcdf****
Tags	object
Tag	array<object>	The information about the tags.
	object
Key	string	The key of tag N added to the resource.	FinanceDept
Value	string	The value of tag N added to the resource.	FinanceJoshua

Examples

Success response

JSON format

{
  "PageSize": "10",
  "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
  "PageNumber": "1",
  "TotalCount": "2",
  "NetworkAcls": {
    "NetworkAcl": [
      {
        "Status": "Available",
        "VpcId": "vpc-m5ebpc2xh64mqm27e****",
        "CreationTime": "2021-12-25 11:44:17",
        "Description": "This is my NetworkAcl.",
        "NetworkAclName": "acl-1",
        "NetworkAclId": "nacl-a2do9e413e0spxscd****",
        "OwnerId": 253460731706911260,
        "RegionId": "cn-hangzhou",
        "IngressAclEntries": {
          "IngressAclEntry": [
            {
              "NetworkAclEntryId": "nae-a2dk86arlydmezasw****",
              "EntryType": "custom",
              "NetworkAclEntryName": "acl-3\t",
              "Policy": "accept",
              "Description": "This is IngressAclEntries.",
              "SourceCidrIp": "10.0.0.0/24\t",
              "IpVersion": "IPv4",
              "Protocol": "all",
              "Port": "-1/-1\t"
            }
          ]
        },
        "EgressAclEntries": {
          "EgressAclEntry": [
            {
              "NetworkAclEntryId": "nae-a2d447uw4tillfvgb****",
              "EntryType": "custom",
              "NetworkAclEntryName": "acl-2\t",
              "Policy": "accept",
              "Description": "This is EgressAclEntries.",
              "Protocol": "all",
              "DestinationCidrIp": "10.0.0.0/24\t",
              "IpVersion": "IPv4",
              "Port": "-1/-1\t"
            }
          ]
        },
        "Resources": {
          "Resource": [
            {
              "Status": "BINDED",
              "ResourceType": "VSwitch",
              "ResourceId": "vsw-bp1de348lntdwcdf****"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	ParameterMissing.AliUid	ParameterMissing.AliUid
400	ParameterMissing.Bid	ParameterMissing.Bid
400	ParameterMissing.RegionId	ParameterMissing.RegionId
400	ParameterEmpty.RegionId	ParameterEmpty.RegionId
400	NotSupport.NetworkAcl	Network acl is not support now.
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.