GetPolicyCheckResult - 查询策略验证结果--云防火墙-火山引擎

文档中心

立即注册

云防火墙

策略验证

GetPolicyCheckResult - 查询策略验证结果

通过输入网络五元组信息（源 IP、目的 IP、协议、源端口、目的端口），快速确认指定流量是被防火墙策略放行还是阻断，便于故障排查。

请求说明

请求方式：POST
请求地址：https://fw-center.volcengineapi.com/?Action=GetPolicyCheckResult&Version=2021-09-06

调试

API Explorer

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

去调试

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
DestPort	String	否	`80`	访问目的端口
Destination	String	是	`180.0.*.*`	访问目的地址
DestinationType	String	否	`net`	访问目的地址类型： net：IP 地址 domain：域名
Direction	String	否	`in`	方向： in：入向（默认值） out：出向
FirewallID	String	是	`vfw-xxxx`	防火墙 ID
FirewallType	String	是	`internet_firewall`	防火墙类型
ForceCheck	Boolean	否	`false`	强制检测，开启后无论是否引流都会检测，默认为 false
ForceMatch	Boolean	否	`false`	强制匹配，开启后会返回所有命中的规则，否则仅返回第一条命中的规则
Protocol	String	是	`TCP`	访问协议： ICMP TCP UDP 注意 DestinationType 取值为 domain 时，Protocol 只支持 TCP 类型。 Protocol 取值为 TCP、UDP 时，DestPort 不能为空。 FirewallType 取值为 nat_firewall 并且 Direction 取值为 in 时，Protocol 不能为 ICMP。
Source	String	是	`180.0.*.*`	访问源地址

返回参数

参数类型示例值描述

Enable Boolean true 是否开启防护

参数	类型	示例值	描述
Enable	Boolean	`true`	是否开启防护
HitResult	String	`deny`	检查结果： deny：拦截 monitor：观察 accept：放行 miss：未命中
HitRuleList	Array of HitRule	`--`	命中的策略列表

HitResult

String

deny

检查结果：

deny：拦截
monitor：观察
accept：放行
miss：未命中

HitRuleList Array of HitRule -- 命中的策略列表

HitRule

参数	类型	示例值	描述
Prio	Long	`1`	策略优先级
Action	String	`deny`	策略动作 monitor：观察 deny：阻断 accept：放行
RuleId	String	`7-be61-310222b7****`	策略 ID
HitSign	Boolean	`true`	命中标记，用于标注实际命中的规则
Protocol	String	`TCP`	访问协议： ICMP TCP UDP
Description	String	`test`	规则描述
DestPortList	Array of String	`["80"]`	访问目的端口
EffectStatus	Integer	`1`	生效状态： 1：未生效 2：下发中 3：已生效
SourceCidrList	Array of String	`["180.0.*.*"]`	访问源地址
DestinationCidrList	Array of String	`["180.0.*.*"]`	访问目的地址

请求示例

POST https://fw-center.volcengineapi.com/?Action=GetPolicyCheckResult&Version=2021-09-06
{
    "DestPort": "80",
    "Destination": "180.0.***.***",
    "DestinationType": "net",
    "Direction": "in",
    "FirewallID": "vfw-xxxx",
    "FirewallType": "internet_firewall",
    "ForceCheck": false,
    "ForceMatch": true,
    "Protocol": "TCP",
    "Source": "180.0.***.***"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "GetPolicyCheckResult",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Enable": true,
        "HitResult": "deny",
        "HitRuleList": [
            {
                "Prio": 1,
                "Action": "deny",
                "RuleId": "7-be61-310222b7****",
                "HitSign": true,
                "Protocol": "TCP",
                "Description": "test",
                "DestPortList": [
                    "80"
                ],
                "EffectStatus": 1,
                "SourceCidrList": [
                    "180.0.***.***"
                ],
                "DestinationCidrList": [
                    "180.0.***.***"
                ]
            }
        ]
    }
}

错误码

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

最近更新时间：2025.12.31 15:16:09

这个页面对您有帮助吗？

有用

无用