查询网络ACL列表

最近更新时间:2024-03-12 02:02:42

我的收藏

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeNetworkAcls)用于查询网络ACL列表。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeNetworkAcls。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 过滤条件,参数不支持同时指定NetworkAclIds和Filters。
  • vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-12345678。
  • network-acl-id - String - (过滤条件)网络ACL实例ID,形如:acl-12345678。
  • network-acl-name - String - (过滤条件)网络ACL实例名称。

  • 示例值:vpc-qw123456
    NetworkAclIds.N Array of String 网络ACL实例ID数组。形如:[acl-12345678]。每次请求的实例的上限为100。参数不支持同时指定NetworkAclIds和Filters。
    示例值:[acl-12345678]
    Offset Integer 偏移量,默认为0。
    示例值:0
    Limit Integer 返回数量,默认为20,最小值为1,最大值为100。
    示例值:20
    OrderField String 排序字段。支持:NetworkAclId,NetworkAclName,CreatedTime
    示例值:CreatedTime
    OrderDirection String 排序方法。顺序:ASC,倒序:DESC。
    示例值:DESC

    3. 输出参数

    参数名称 类型 描述
    NetworkAclSet Array of NetworkAcl 实例详细信息列表。
    TotalCount Integer 符合条件的实例数量。
    示例值:1
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 示例1 查询网络ACL列表

    查询网络ACL列表

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeNetworkAcls
    <公共请求参数>
    
    {}

    输出示例

    {
        "Response": {
            "NetworkAclSet": [
                {
                    "VpcId": "vpc-c1fd6eqe",
                    "NetworkAclId": "acl-aeyasc3zz",
                    "NetworkAclName": "ddd",
                    "NetworkAclType": "1",
                    "CreatedTime": "2021-02-19 17:52:43",
                    "SubnetSet": [
                        {
                            "VpcId": "vpc-c1fd6eqe",
                            "SubnetId": "subnet-ptqwqcjzd",
                            "SubnetName": "test_3",
                            "CidrBlock": "10.0.0.0/24",
                            "IsDefault": true,
                            "EnableBroadcast": true,
                            "Zone": "ap-beijing",
                            "RouteTableId": "rtb-hnos32zkc",
                            "CreatedTime": "2021-02-19 17:52:43",
                            "AvailableIpAddressCount": 1,
                            "Ipv6CidrBlock": "",
                            "NetworkAclId": "acl-aeyasc3zz",
                            "IsRemoteVpcSnat": true,
                            "TotalIpAddressCount": 1,
                            "TagSet": [
                                {
                                    "Key": "abc",
                                    "Value": "abc"
                                }
                            ],
                            "CdcId": "cdc-12312",
                            "IsCdcSubnet": 0
                        }
                    ],
                    "IngressEntries": [
                        {
                            "Protocol": "all",
                            "Ipv6CidrBlock": "::/0",
                            "Action": "Accept",
                            "Description": "",
                            "ModifyTime": "",
                            "NetworkAclIpv6EntryId": "acli63-bwi12ozo",
                            "Priority": 1
                        }
                    ],
                    "EgressEntries": [
                        {
                            "Protocol": "all",
                            "Ipv6CidrBlock": "::/0",
                            "Action": "Accept",
                            "Description": "",
                            "ModifyTime": "",
                            "NetworkAclIpv6EntryId": "acli63-pmh23vc1q",
                            "Priority": 1
                        }
                    ],
                    "TagSet": [
                        {
                            "Key": "test",
                            "Value": "1"
                        }
                    ]
                }
            ],
            "TotalCount": 1,
            "RequestId": "abc"
        }
    }

    示例2 示例2 根据条件查询网络ACL列表

    根据条件查询网络ACL列表

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeNetworkAcls
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Name": "vpc-id",
                "Values": [
                    "vpc-nwg3twqu"
                ]
            }
        ],
        "Offset": 1,
        "Limit": 1
    }

    输出示例

    {
        "Response": {
            "NetworkAclSet": [
                {
                    "VpcId": "vpc-nwg3twqu",
                    "NetworkAclId": "acl-3v122sn",
                    "NetworkAclName": "111111",
                    "NetworkAclType": "TRIPLE",
                    "CreatedTime": "2022-04-27 20:46:15",
                    "TagSet": [],
                    "SubnetSet": [],
                    "IngressEntries": [
                        {
                            "Protocol": "all",
                            "Ipv6CidrBlock": "::/0",
                            "Action": "Drop",
                            "Description": "",
                            "ModifyTime": "",
                            "NetworkAclIpv6EntryId": "acli63-7whoqwek",
                            "Priority": 1
                        },
                        {
                            "Protocol": "all",
                            "CidrBlock": "172.16.0.0/16",
                            "Action": "Drop",
                            "Description": "",
                            "ModifyTime": "",
                            "NetworkAclIpv4EntryId": "acli43-dd0lxs1c",
                            "Priority": 1
                        },
                        {
                            "Protocol": "all",
                            "CidrBlock": "0.0.0.0/0",
                            "Action": "Drop",
                            "Description": "",
                            "ModifyTime": "",
                            "NetworkAclIpv4EntryId": "acli43-ezxjnhgy",
                            "Priority": 2
                        }
                    ],
                    "EgressEntries": [
                        {
                            "Protocol": "all",
                            "Ipv6CidrBlock": "::/0",
                            "Action": "Drop",
                            "Description": "",
                            "ModifyTime": "",
                            "NetworkAclIpv6EntryId": "acli63-pwqzahcs",
                            "Priority": 1
                        },
                        {
                            "Protocol": "all",
                            "CidrBlock": "0.0.0.0/0",
                            "Action": "Drop",
                            "Description": "",
                            "ModifyTime": "",
                            "NetworkAclIpv4EntryId": "acli43-ob44ewjm",
                            "Priority": 1
                        }
                    ]
                }
            ],
            "TotalCount": 1,
            "RequestId": "87c50ae4-bfd84-48cf-b92e-b637cewdd2aa"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalError.ModuleError 内部模块错误。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。
    UnsupportedOperation 操作不支持。
    UnsupportedOperation.ActionNotFound 接口不存在。