You need to enable JavaScript to run this app.
导航
云防火墙
  • 文档首页
    • /云防火墙/API参考/NAT边界防火墙/DescribeNatFirewallControlPolicy - 查询 NAT 边界防火墙访问控制策略列表
DescribeNatFirewallControlPolicy - 查询 NAT 边界防火墙访问控制策略列表
最近更新时间：2025.05.29 17:45:46首次发布时间：2024.11.24 23:48:55
我的收藏
有用
有用
无用
无用

调用此接口，通过策略方向和 NAT 实例 ID，可以查询实例下该方向的访问控制策略列表详情。

请求说明

  • 请求方式：POST
  • 请求地址：https://fw_center.volcengineapi.com/?Action=DescribeNatFirewallControlPolicy&Version=2021-09-06

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

Query

参数类型是否必选示例值描述
ActionString是DescribeNatFirewallControlPolicy接口名称。当前 API 的名称为 DescribeNatFirewallControlPolicy。
VersionString是2021-09-06接口版本。当前 API 的版本为 2021-09-06。

Body

参数类型是否必选示例值描述

Action

Array of String

否

accept

策略动作，精确匹配。

  • accept： 放行
  • deny： 阻断
  • monitor： 观察
DescriptionString否允许来自 180.*.*.1/32 的 TCP 80 端口访问策略描述信息，支持模糊匹配查询。
DestPortArray of String否["80","443"]目的端口，用于精确匹配查询条件。支持多个端口值进行查询。
DestinationArray of String否["180.*.*.*"]目的地址，用于模糊匹配查询条件。支持多个地址值进行查询。

Direction

String

是

in

策略方向，用于指定访问控制策略的应用方向。

  • in：入方向；
  • out：出方向。
NatFirewallIdString是nfw-********NAT 边界防火墙实例 ID。获取方式可参考DescribeNatFirewallList - 查询NAT边界防火墙实例列表。
PageNumberInteger否1分页页码，默认值为 1。
PageSizeInteger否10分页大小，默认值为 10。

Proto

Array of String

否

["TCP","UDP"]

协议类型，用于精确匹配查询条件。支持以下协议类型：

  • ICMP
  • TCP
  • UDP
  • ANY（任何协议）

RepeatType

Array of String

否

Once

策略的重复类型，用于精确匹配查询条件。支持以下类型：

  • Permanent：始终生效；
  • Once：单次生效；
  • Daily：每日重复；
  • Weekly：每周重复；
  • Monthly：每月重复。
RuleIdArray of String否f04ac7ce-****-****-****-************访问控制策略唯一标识 ID。获取方式可参考DescribeNatFirewallControlPolicy - 查询 NAT 边界防火墙访问控制策略列表。
SourceArray of String否["180.*.*.1/32"]源地址，用于模糊匹配查询条件。支持多个地址值进行查询。

Status

Array of Boolean

否

true

策略启用状态，精确匹配。

  • true：开启；
  • false：关闭。

返回参数

参数类型示例值描述
CountInteger10返回数据的实际数量，表示当前页面返回的 NAT 边界防火墙访问控制策略数量。当查询数据为空且使用 Python SDK 调用时，此项为 None。
DataArray of DescribeControlPolicyDetailV1--策略详情。
PageNumberInteger1返回数据的分页页码，表示当前查询结果所在的页码。
PageSizeInteger10返回数据的分页大小，表示每页显示的 NAT 边界防火墙访问控制策略数量。
TotalCountInteger14返回的策略总量，表示符合查询条件的 NAT 边界防火墙访问控制策略总数。当查询数据为空且使用 Python SDK 调用时，此项为 None。

DescribeControlPolicyDetailV1

参数类型示例值描述
PrioInteger1规则优先级，数值越小优先级越高。
ProtoStringTCP规则协议，表示访问控制策略所适用的网络协议类型。
ActionStringdeny规则动作
HitCntInteger70规则命中次数，表示该访问控制策略被匹配并执行的次数。

IpType

String

v4

IP 地址的类型，取值如下所示。

  • v4：IPv4 地址；
  • v6：IPv6 地址。
RuleIdStringf04ac7ce-628b-4cb7-be61-310222b7****访问控制策略的唯一标识，用于唯一区分不同的 NAT 边界防火墙访问控制策略。

Source

String

180.*.*.1/32

源地址，根据 SourceType 的不同取值有不同的格式要求。

  • 当 SourceType 为 net 时，格式为源 CIDR 地址，例如：180.*.*.1/32；
  • 当 SourceType 为 group 时，格式为源地址簿的 UUID 列表，最多支持 50 个地址簿，多个地址簿用英文逗号分隔，例如：`f04ac7ce----********； |
  • 当 SourceType 为 location 时，格式为源区域代码，多个地域用英文逗号分隔，例如：BJ11, ZB。

Status

Boolean

true

访问控制策略的开关状态，默认值为 false（关闭）。

  • true：开启；
  • false：关闭。
EndTimeInteger1727247865策略生效截止日期，Unix 时间戳。

DestPort

String

832a5162-5949-4953-b789-********

目的端口，格式为单个端口 22 或端口范围 100/200。

  • 当协议类型为 ICMP 或 ALL 时，该字段为空；
  • 当 DestPortType 为 group 时，该字段为端口地址簿的 UUID 列表，多个地址簿通过英文逗号分隔；
  • 当 DestPortType 为 port 时，该字段为端口范围。
UseCountInteger1使用策略数，表示当前访问控制策略被引用的次数。
AccountIdString2100052276账号的唯一标识符，用于区分不同的云服务账号。

Direction

String

out

规则的方向，表示访问控制策略的流量方向。

  • out：出方向；
  • in：入方向。
StartTimeInteger1727247865策略生效起始日期，Unix 时间戳。

IsEffected

Boolean

true

表示访问控制策略是否生效的状态。

  • true：已生效；
  • false：未生效。
RepeatDaysArray of Integer[1,3,5]策略重复生效的日期列表，表示该访问控制策略在每周的哪些天生效。日期范围为 1（周一）至 7（周日）。

RepeatType

String

Permanent

重复类型，用于指定策略生效的时间周期。

  • Permanent：始终生效；
  • Once：单次生效；
  • Daily：每日重复；
  • Weekly：每周重复；
  • Monthly：每月重复。

SourceType

String

group

源地址的类型，用于指定访问控制策略中源地址的格式和来源。

  • net：表示源地址为 CIDR 格式的 IP 地址段；
  • group：表示源地址为地址簿的 UUID 列表；
  • location：表示源地址为地域代码。
UpdateTimeInteger1714298363访问控制策略的最后更新时间，以 Unix 时间戳格式表示。该字段记录了策略配置或状态变更的具体时间点。
DescriptionStringhttp deny访问控制策略的描述信息，用于记录该策略的用途、备注或其他相关信息。

Destination

String

example.com

目的地址，根据 DestinationType 的不同取值有不同的格式要求。

  • 当 DestinationType 为 domain 时，格式为域名，例如：example.com；
  • 当 DestinationType 为 group 时，格式为目的地址簿的 UUID 列表，多个地址簿用英文逗号分隔；
  • 当 DestinationType 为 net 时，格式为目的 CIDR 地址。
LastHitTimeInteger1703157199表示该访问控制策略上次被匹配并执行的具体时间点，以 Unix 时间戳格式记录。该字段可用于分析策略的使用频率和活跃程度。
DestPortListArray of String["80","443","8080/8090"]目的端口列表，表示访问控制策略中配置的目的端口集合。支持单个端口（如 22）或端口范围（如 100/200）的格式。

DestPortType

String

group

目的端口类型，用于指定访问控制策略中目的端口的格式和来源。

  • group：表示目的端口为端口地址簿的 UUID 列表；
  • port：表示目的端口为端口范围。

EffectStatus

Integer

3

访问控制策略的生效状态，取值如下所示。

  • 1：未生效；
  • 2：下发中；
  • 3：已生效。
RepeatEndTimeString2024-09-10 12:00策略重复生效的结束时间，格式为 YYYY-MM-DD HH:MM。该字段与 RepeatStartTime 共同定义策略生效的时间窗口。

SourceCidrList

Array of String

["192.168.0.1/24","10.0.0.1/32"]

访问控制策略的源地址列表，表示该策略适用的源 IP 地址或地址段。

  • 当 SourceType 为 net 时，列表中每个元素表示一个 CIDR 格式的 IP 地址段；
  • 当 SourceType 为 group 时，列表中每个元素表示一个源地址簿的 UUID。

DestinationType

String

domain

目的地址的类型，用于指定访问控制策略中目的地址的格式和来源。

  • domain：表示目的地址为域名；
  • group：表示目的地址为地址簿的 UUID 列表；
  • net：表示目的地址为 CIDR 格式的 IP 地址段。
RepeatStartTimeString2024-09-10 11:00策略重复生效的开始时间，格式为 YYYY-MM-DD HH:MM。该字段与 RepeatEndTime 共同定义策略生效的时间窗口。
SourceGroupListArray of String["address-book-1","address-book-2"]源地址组列表，表示访问控制策略中配置的源地址组集合。每个元素代表一个地址组的标识符，用于引用预定义的地址组。

SourceGroupType

String

ip

源地址组的类型，用于指定访问控制策略中源地址组的格式和来源。

  • ip：表示源地址组为 IP 地址；
  • domain：表示源地址组为域名；
  • port：表示源地址组为端口。
DestPortGroupListArray of String["port-group-1","port-group-2"]目的端口组列表，表示访问控制策略中配置的目的端口组集合。每个元素代表一个端口组的标识符，用于引用预定义的端口组。

DestPortGroupType

String

port

目的端口组的类型，用于指定访问控制策略中目的端口组的格式和来源。

  • port：表示目的端口组为端口；
  • 其他类型根据具体业务场景定义。
DestinationCidrListArray of String["10.0.0.0/24","192.168.1.0/28"]目的地址列表，表示访问控制策略中配置的目的 IP 地址集合，用于精确匹配目的网络范围。
DestinationGroupListArray of String["address-book-1","address-book-2"]目的地址组列表，表示访问控制策略中配置的目的地址组集合。每个元素代表一个地址组的标识符，用于引用预定义的地址组。

DestinationGroupType

String

ip

目的地址组的类型，用于指定访问控制策略中目的地址组的格式和来源。

  • ip：引用地址簿
  • 为空：未引用地址簿

请求示例

POST https://fw_center.volcengineapi.com/?Action=DescribeNatFirewallControlPolicy&Version=2021-09-06
{
    "NatFirewallId": "nfw-ydikubquio87cpnv****",
    "PageNumber": 1,
    "PageSize": 10,
    "Direction": "in"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DescribeNatFirewallControlPolicy",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "TotalCount": 2,
        "PageSize": 10,
        "PageNumber": 1,
        "Count": 10,
        "Data": [
            {
                "AccountId": "2100052970",
                "NatFirewallId": "nfw-ydikubquio87cpnv****",
                "Direction": "in",
                "RuleId": "5e8d76d7-****-4662-8d27-c1391bb332d8",
                "Prio": 1,
                "Proto": "TCP",
                "Action": "monitor",
                "Status": false,
                "HitCnt": 0,
                "LastHitTime": 0,
                "Description": "",
                "Source": "192.128.**.**",
                "SourceType": "net",
                "SourceGroupType": "",
                "Destination": "3a1516b6-****-4aeb-a27e-a1524cf37b42",
                "DestinationType": "group",
                "DestinationGroupType": "ip",
                "DestPort": "e049a55f-****-46ab-ba5e-a91630fb79c5",
                "DestPortType": "group",
                "DestPortGroupType": "port",
                "SourceCidrList": [
                    "192.168.**.**"
                ],
                "SourceGroupList": null,
                "DestinationCidrList": [
                    "192.128.**.**",
                    "192.128.**.**"
                ],
                "DestinationGroupList": [
                    "IP地址簿1"
                ],
                "DestPortList": [
                    "2/2",
                    "3/3"
                ],
                "DestPortGroupList": [
                    "端口地址簿1"
                ],
                "UseCount": 4,
                "IsEffected": true,
                "EffectStatus": 3,
                "UpdateTime": 1732181581,
                "RepeatType": "Daily",
                "StartTime": 1732032000,
                "EndTime": 4102415940,
                "RepeatStartTime": "00:00",
                "RepeatEndTime": "00:00",
                "RepeatDays": []
            },
            {
                "AccountId": "2100052970",
                "NatFirewallId": "nfw-ydikubquio87cpnv****",
                "Direction": "in",
                "RuleId": "44ef642c-****-49cb-bff6-5d29737b4893",
                "Prio": 2,
                "Proto": "TCP",
                "Action": "deny",
                "Status": false,
                "HitCnt": 1,
                "LastHitTime": 1732160419,
                "Description": "",
                "Source": "HK",
                "SourceType": "location",
                "SourceGroupType": "",
                "Destination": "192.168.***.**",
                "DestinationType": "net",
                "DestinationGroupType": "",
                "DestPort": "80",
                "DestPortType": "port",
                "DestPortGroupType": "",
                "SourceCidrList": [
                    "HK"
                ],
                "SourceGroupList": null,
                "DestinationCidrList": [
                    "192.168.1.2"
                ],
                "DestinationGroupList": null,
                "DestPortList": [
                    "80"
                ],
                "DestPortGroupList": null,
                "UseCount": 1,
                "IsEffected": true,
                "EffectStatus": 3,
                "UpdateTime": 1732102767,
                "RepeatType": "Monthly",
                "StartTime": 1732032000,
                "EndTime": 4102415940,
                "RepeatStartTime": "00:00",
                "RepeatEndTime": "00:00",
                "RepeatDays": [
                    3,
                    4
                ]
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。