DescribeNetworkAcls

Last updated: 2020-06-24 12:19:36

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to query a list of network ACLs.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeNetworkAcls.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
NetworkAclIds.N No Array of String Array of network ACL instance IDs, such as [acl-12345678]. Up to 100 instances are allowed for each request. This parameter does not support specifying NetworkAclIds and Filters at the same time.
Filters.N No Array of Filter Filter condition. NetworkAclIds and Filters cannot be specified at the same time.
  • vpc-id - String - (Filter condition) VPC instance ID, such as vpc-12345678.
  • network-acl-id - String - (Filter condition) Network ACL instance ID, such as acl-12345678.
  • network-acl-name - String - (Filter condition) Network ACL instance name.
  • Offset No Integer Offset. Default: 0.
    Limit No Integer Returned quantity. Default: 20. Value range: 1-100.

    3. Output Parameters

    Parameter Name Type Description
    NetworkAclSet Array of NetworkAcl List of instance details.
    TotalCount Integer Number of eligible instances.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Example 1: Querying the network ACL list

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeNetworkAcls
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "NetworkAclSet": [
          {
            "VpcId": "vpc-12345678",
            "SubnetName": "acl-12345678",
            "NetworkAclName": "test",
            "CreatedTime": "2020-01-01 10:00:00",
            "SubnetSet": [
              {
                "SubnetId": "subnet-12345678",
                "SubnetName": "test",
                "CidrBlock": "172.16.12.0/24"
              }
            ],
            "IngressEntries": [
              {
                "Protocol": "tcp",
                "CidrBlock": "172.16.12.123/32",
                "Action": "Accept",
                "Description": "test",
                "Port": 8080
              },
              {
                "Protocol": "all",
                "CidrBlock": "0.0.0.0/0",
                "Action": "Drop",
                "Description": ""
              }
            ],
            "EgressEntries": [
              {
                "Protocol": "tcp",
                "CidrBlock": "172.16.12.123/32",
                "Action": "Accept",
                "Description": "test",
                "Port": 8080
              },
              {
                "Protocol": "all",
                "CidrBlock": "0.0.0.0/0",
                "Action": "Drop",
                "Description": ""
              }
            ]
          }
        ],
        "TotalCount": 1,
        "RequestId": "5efe6fa7-6de2-4ce9-911a-f7438bf697d4"
      }
    }

    Example2 Example 2: Querying the network ACL list by conditions

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeNetworkAcls
    &NetworkAclIds.0=acl-12345678
    &Offset=0
    &Limit=20
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "NetworkAclSet": [
          {
            "VpcId": "vpc-12345678",
            "NetworkAclId": "acl-12345678",
            "NetworkAclName": "test",
            "CreatedTime": "2020-01-01 10:00:00",
            "SubnetSet": [
              {
                "SubnetId": "subnet-12345678",
                "SubnetName": "test",
                "CidrBlock": "172.16.12.0/24"
              }
            ],
            "IngressEntries": [
              {
                "Protocol": "tcp",
                "CidrBlock": "172.16.12.123/32",
                "Action": "Accept",
                "Description": "test",
                "Port": 8080
              },
              {
                "Protocol": "all",
                "CidrBlock": "0.0.0.0/0",
                "Action": "Drop",
                "Description": ""
              }
            ],
            "EgressEntries": [
              {
                "Protocol": "tcp",
                "CidrBlock": "172.16.12.123/32",
                "Action": "Accept",
                "Description": "test",
                "Port": 8080
              },
              {
                "Protocol": "all",
                "CidrBlock": "0.0.0.0/0",
                "Action": "Drop",
                "Description": ""
              }
            ]
          }
        ],
        "TotalCount": 1,
        "RequestId": "5efe6fa7-6de2-4ce9-911a-f7438bf697d4"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameter.Coexist The parameters cannot be specified at the same time.
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.Range The parameter value is not in the specified range.
    ResourceNotFound The resource does not exist.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help