tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Virtual Private Cloud
    Documentation
    Download PDF

    DescribeNetworkAcls

    Last updated: 2024-11-25 20:08:30
    Download PDF

      1. API Description

      Domain name for API request: vpc.intl.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.

      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 Params. The value used for this API: DescribeNetworkAcls.
      Version Yes String Common Params. The value used for this API: 2017-03-12.
      Region Yes String Common Params. 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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

      4. Example

      Example1 Example 1. Querying the network ACL list

      This example shows you how to query the list of network ACLs.

      Input Example

      POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNetworkAcls
<Common request parameters>

{}

      Output Example

      {
    "Response": {
        "TotalCount": 1,
        "NetworkAclSet": [
            {
                "TagSet": [],
                "NetworkAclId": "acl-kmxukyv6",
                "VpcId": "vpc-9it989fn",
                "NetworkAclType": "TRIPLE",
                "IngressEntries": [
                    {
                        "Protocol": "all",
                        "Description": "Test 1",
                        "Ipv6CidrBlock": "::/0",
                        "ModifyTime": "2020-01-21 14:26:22",
                        "Action": "Drop",
                        "CidrBlock": "0.0.0.0/0",
                        "Port": "80"
                    }
                ],
                "SubnetSet": [
                    {
                        "NetworkAclId": "acl-kmxukyv6",
                        "RouteTableId": "rtb-we123456",
                        "VpcId": "vpc-rt123456",
                        "EnableBroadcast": true,
                        "Zone": "ap-guangzhou",
                        "Ipv6CidrBlock": "::/0",
                        "AvailableIpAddressCount": 1,
                        "IsRemoteVpcSnat": true,
                        "SubnetName": "Subnet 1",
                        "TotalIpAddressCount": 1,
                        "IsCdcSubnet": 0,
                        "CdcId": "cluster-gbo27yc4",
                        "TagSet": [
                            {
                                "Value": "og",
                                "Key": "ck"
                            }
                        ],
                        "CreatedTime": "2020-01-20 14:26:22",
                        "SubnetId": "subnet-qmqye6ew",
                        "CidrBlock": "10.0.0.0/24",
                        "IsDefault": true
                    }
                ],
                "NetworkAclName": "Test 001",
                "CreatedTime": "2020-01-20 14:26:22",
                "EgressEntries": [
                    {
                        "Protocol": "All",
                        "Description": "测试222",
                        "Ipv6CidrBlock": "::/0",
                        "ModifyTime": "2020-01-20 14:26:22",
                        "Action": "Drop",
                        "CidrBlock": "10.0.0.0/24",
                        "Port": "80"
                    }
                ]
            }
        ],
        "RequestId": "cccb2665-5d02-4d87-b9e7-757bb06e5beb"
    }
}

      Example2 Example 2: Querying the network ACL list by conditions

      This example shows you how to query the specified network ACLs.

      Input Example

      POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNetworkAcls
<Common request parameters>

{
    "NetworkAclIds": [
        "acl-12345678"
    ],
    "Limit": 20,
    "Offset": 0
}

      Output Example

      {
    "Response": {
        "TotalCount": 1,
        "NetworkAclSet": [
            {
                "TagSet": [],
                "NetworkAclId": "",
                "VpcId": "vpc-kj123456",
                "NetworkAclType": "TRIPLE",
                "IngressEntries": [
                    {
                        "Protocol": "all",
                        "Description": "Test 1",
                        "Ipv6CidrBlock": "::/0",
                        "ModifyTime": "2020-01-21 14:26:22",
                        "Action": "Drop",
                        "CidrBlock": "0.0.0.0/0",
                        "Port": "80"
                    }
                ],
                "SubnetSet": [
                    {
                        "NetworkAclId": "acl-kmxukyv6",
                        "RouteTableId": "rtb-we123456",
                        "VpcId": "vpc-kj123456",
                        "EnableBroadcast": true,
                        "Zone": "ap-guangzhou",
                        "Ipv6CidrBlock": "::/0",
                        "AvailableIpAddressCount": 1,
                        "IsCdcSubnet": 0,
                        "CdcId": "cluster-gbo27yc4",
                        "IsRemoteVpcSnat": true,
                        "SubnetName": "Test 01",
                        "TotalIpAddressCount": 1,
                        "TagSet": [
                            {
                                "Value": "yt",
                                "Key": "kj"
                            }
                        ],
                        "CreatedTime": "2020-01-21 14:26:22",
                        "SubnetId": "subnet-qmqye6ew",
                        "CidrBlock": "10.0.0.0/24",
                        "IsDefault": true
                    }
                ],
                "NetworkAclName": "Test 33",
                "CreatedTime": "2020-01-21 14:26:22",
                "EgressEntries": [
                    {
                        "Protocol": "All",
                        "Description": "Test",
                        "Ipv6CidrBlock": "::/0",
                        "ModifyTime": "2020-01-21 14:26:22",
                        "Action": "Drop",
                        "CidrBlock": "10.0.0.0/24",
                        "Port": "80"
                    }
                ]
            }
        ],
        "RequestId": "cccb2665-5d02-4d87-b9e7-757bb06e5beb"
    }
}

      5. Developer Resources

      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
      InternalError.ModuleError Internal module error
      InvalidParameter.Coexist The parameters cannot be specified at the same time.
      InvalidParameter.FilterInvalidKey The specified filter condition does not exist.
      InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
      InvalidParameterValue.Malformed Invalid input parameter format.
      InvalidParameterValue.NotUtf8EncodingError
      InvalidParameterValue.Range The parameter value is not in the specified range.
      ResourceNotFound The resource does not exist.
      UnsupportedOperation Unsupported operation.
      UnsupportedOperation.ActionNotFound The port does not exist.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy