DescribeNatFirewallControlPolicy - 查询 NAT 边界防火墙访问控制策略列表--云防火墙-火山引擎

文档中心

立即注册

导航

DescribeNatFirewallControlPolicy - 查询 NAT 边界防火墙访问控制策略列表

最近更新时间：2024.11.25 17:03:54首次发布时间：2024.11.24 23:48:55

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

请求说明

请求方式：POST
请求地址：?Action=DescribeNatFirewallControlPolicy&Version=2021-09-06

调试

API Explorer

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

去调试

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
Action	Array of String	否	`accept`	策略动作，精确匹配。 `accept`：放行 `deny`：阻断 `monitor`：观察
Description	String	否	`Description`	策略描述信息，模糊匹配。
DestPort	Array of String	否	`80`	目的端口，精确匹配。
Destination	Array of String	否	`180...*`	目的地址，模糊匹配。
Direction	String	是	`in`	策略方向： in：入向 out：出向
NatFirewallId	String	是	`nfw-********`	NAT 边界防火墙实例 ID。获取方式可参考DescribeNatFirewallList - 查询NAT边界防火墙实例列表。
PageNumber	Integer	否	`1`	分页页码，默认值为 1。
PageSize	Integer	否	`10`	分页大小，默认值为 10。
Proto	Array of String	否	`TCP`	协议类型，精确匹配。 ICMP TCP UDP ANY(任何协议)
RepeatType	Array of String	否	`Once`	重复类型，精确匹配。 Permanent：始终生效 Once：单次生效 Daily：每日重复 Weekly：每周重复 Monthly：每月重复
RuleId	Array of String	否	`f04ac7ce-**---**********`	访问控制策略 ID，模糊查询。
Source	Array of String	否	`180...1/32`	源地址，模糊匹配。
Status	Array of Boolean	否	`true`	策略启用状态，精确匹配。 true：开启 false：关闭

返回参数

参数	类型	示例值	描述
Count	Integer	`10`	当前页面返回的策略数量。
Data	Array of NatFirewallControlPolicyStructure	`--`	策略详情。
PageNumber	Integer	`1`	返回数据的分页页码
PageSize	Integer	`10`	返回数据的分页大小.
TotalCount	Integer	`14`	返回的策略总量。

NatFirewallControlPolicyStructure

参数	类型	示例值	描述
Prio	Integer	`3`	优先级。
Proto	String	`TCP`	协议类型。 ICMP TCP UDP ANY(任何协议)
Action	String	`deny`	策略动作： `accept`：放行 `deny`：阻断 `monitor`：观察
HitCnt	Integer	`10`	规则命中次数。
RuleId	String	`f04ac7ce-**---**********`	访问控制策略唯一标识 ID。
Source	String	`f04ac7ce-**---**********`	源地址。当SourceType为net时，Source为源CIDR地址。例如：180.. .1/32 当SourceType为group时，Source为源地址簿的uuid。例如：f04ac7ce----******** 当SourceType为区域时，Source为区域代码。例如：BJ11
Status	Boolean	`true`	策略启用状态。 true：开启 false：关闭
EndTime	Integer	`1727247865`	策略生效截止日期，精确到设定日期的 23:59:00。
DestPort	String	`f04ac7ce-**---**********`	目的端口。当协议类型为ICMP/ALL时，取值为空当DestPortType为group时，取值为端口地址簿的uuid列表，多个地址簿通过英文逗号分隔当DestPortType为port时，取值为端口范围。
UseCount	Integer	`10`	占用策略数。
AccountId	String	`2100052276`	账号 ID。
Direction	String	`in`	策略方向： in：入向 out：出向
StartTime	Integer	`1727247865`	策略生效开始日期，精确到设定日期的 00:00:00。
IsEffected	Boolean	`true`	是否生效。 true：生效 false：不生效
RepeatDays	Array of Integer	`1`	重复生效周期。
RepeatType	String	`Once`	重复类型。 Permanent：始终生效 Once：单次生效 Daily：每日重复 Weekly：每周重复 Monthly：每月重复
SourceType	String	`group`	源地址类型。 net：网段(CIDR) group：地址簿 location：区域
UpdateTime	Integer	`1699835536`	更新时间。
Description	String	`description`	描述信息。
Destination	String	`********.com`	目的地址: 当DestinationType为net时，Destination为目的CIDR地址。例如：192.168.0.2/32 当DestinationType为group时，Destination为目的址簿的uuid。例如：f04ac7ce----****** 当DestinationType为Domain时，Destination为目的域名。例如：******.com 当DestinationType为区域时，Destination为区域代码。例如：BJ11
LastHitTime	Integer	`1699835536`	最近一次命中时间。
DestPortList	Array of String	`80`	目的端口组列表。
DestPortType	String	`group`	目的端口类型。 port：端口 group：端口地址簿
EffectStatus	Integer	`1`	生效状态。 1：未生效 2：下发中 3：已生效
NatFirewallId	String	`nfw-********`	NAT 边界防火墙实例 ID。
RepeatEndTime	String	`00:00`	重复生效截止时间。
SourceCidrList	Array of String	`192.128..`	源地址组列表。
DestinationType	String	`domain`	目的地址类型。 net：目的网段(CIDR) group：目的地址簿 location：目的区域 domain：目的域名
RepeatStartTime	String	`00:00`	重复生效起始时间。
SourceGroupList	Array of String	``	源地址组列表，展示为地址簿名称。为空表示未引用地址簿。
SourceGroupType	String	`ip`	源地址组类型。 ip：引用地址簿为空：未引用地址簿
DestPortGroupList	Array of String	``	目的端口组列表，展示为端口地址簿名称。为空表示未引用端口地址簿。
DestPortGroupType	String	`port`	目的端口组类型。 port：引用端口地址簿为空：未引用端口地址簿
DestinationCidrList	Array of String	`192.128..,192.128..`	目的地址组详情。
DestinationGroupList	Array of String	``	目的地址组列表，展示为地址簿名称。为空表示未引用地址簿。
DestinationGroupType	String	`ip`	目的地址组类型。 ip：引用地址簿为空：未引用地址簿

请求示例

POST ?Action=DescribeNatFirewallControlPolicy&Version=2021-09-06
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T081413Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"NatFirewallId": "nfw-ydikubquio87cpnv****",
"PageNumber": 1,
"PageSize": 10,
"Direction": "in"
}
json

返回示例

{
    "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
                ]
            }
        ]
    }
}
json

UpdateNatFirewallControlPolicySwitch - 更新 NAT 边界防火墙访问控制策略状态

ModifyNatFirewallControlPolicy - 更新 NAT 边界防火墙访问控制策略