GetPolicyAnalyzeDetail - 获取策略分析详情--云防火墙-火山引擎

文档中心

立即注册

云防火墙

策略分析

GetPolicyAnalyzeDetail - 获取策略分析详情

获取指定防火墙、指定检查类型的策略分析详情，包括问题类型、方向、状态以及策略 ID 等信息。

请求说明

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

调试

API Explorer

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

去调试

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
AnalyzeTypeList	Array of String	是	`["NoTraffic"]`	策略检查类型： NoTraffic：无流量命中策略 SameSrcDst：源地址与目的地址相同策略 NoBlockCover：兜底非全阻断策略 HighRiskPort：高风险端口放行策略 LooseLimit：管控过于宽松策略 Deep：深度分析策略
CloudFirewallId	String	否	`CloudFirewall********`	云防火墙实例 ID
Dir	String	否	`in`	方向： in：入向 out：出向
FirewallId	String	否	`vfw-xxxx`	防火墙 ID
FirewallTypeList	Array of String	是	`["internet_firewall"]`	检测的防火墙类型: internet_firewall：互联网边界防火墙 vpc_firewall：VPC 边界防火墙 nat_firewall：NAT 边界防火墙
PageNumber	Integer	否	`1`	分页页码，取值需大于等于 1，默认值为 1
PageSize	Integer	否	`10`	分页大小，取值范围：1~100，默认值为 10
ConflictType	String	否	`Same`	深度分析策略中检测出的冲突类型： Same：重复冗余 Diff：业务冲突

返回参数

参数	类型	示例值	描述
Count	Integer	`10`	返回数据的实际数量说明如果查询数据为空，且使用 Python SDK 调用本接口，该参数返回 None。
Data	Array of PolicyAnalyzeDetail	`--`	策略分析详细数据
PageNumber	Integer	`1`	返回数据的分页页码
PageSize	Integer	`10`	返回数据的分页大小
TotalCount	Integer	`1`	返回数据的总数量说明如果查询数据为空，且使用 Python SDK 调用本接口，该参数返回 None。

PolicyAnalyzeDetail

参数	类型	示例值	描述
Dir	String	`in`	方向： in：入向 out：出向
RuleId	String	`7-be61-310222b7****`	策略 ID
Status	String	`Normal`	状态： Normal：正常 Ignore：忽略
FirewallId	String	`vfw-xxxx`	防火墙 ID
AnalyzeType	String	`NoTraffic`	策略检查类型： NoTraffic：无流量命中策略 SameSrcDst：源地址与目的地址相同策略 NoBlockCover：兜底非全阻断策略 HighRiskPort：高风险端口放行策略 LooseLimit：管控过于宽松策略 Deep：深度分析策略
FirewallType	String	`internet_firewall`	防火墙类型： internet_firewall：互联网边界防火墙 vpc_firewall：VPC 边界防火墙 nat_firewall：NAT 边界防火墙
ConflictDetail	Object of PolicyAnalyzeConflictDetail	`--`	深度分析策略中，冲突的策略详情

PolicyAnalyzeConflictDetail

参数类型示例值描述

参数	类型	示例值	描述
ConflictType	String	`Same`	冲突类型： Same：重复冗余 Diff：业务冲突
ConflictRuleIDList	Array of PolicyAnalyzeConflictRuleDetail	`--`	冲突的策略列表

ConflictType

String

Same

冲突类型：

Same：重复冗余
Diff：业务冲突

ConflictRuleIDList Array of PolicyAnalyzeConflictRuleDetail -- 冲突的策略列表

PolicyAnalyzeConflictRuleDetail

参数	类型	示例值	描述
Cover	Boolean	`true`	是否覆盖
RuleId	String	`7-be61-310222b7****`	策略 ID

请求示例

POST https://fw-center.volcengineapi.com/?Action=GetPolicyAnalyzeDetail&Version=2021-09-06
{
    "AnalyzeTypeList": [
        "NoTraffic"
    ],
    "CloudFirewallId": "CloudFirewall********",
    "ConflictType": "Same",
    "Dir": "in",
    "FirewallId": "vfw-xxxx",
    "FirewallTypeList": [
        "internet_firewall"
    ],
    "PageNumber": 1,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "Action": "GetPolicyAnalyzeDetail",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Count": 10,
        "Data": [
            {
                "Dir": "in",
                "RuleId": "7-be61-310222b7****",
                "Status": "Normal",
                "FirewallId": "vfw-xxxx",
                "AnalyzeType": "NoTraffic",
                "FirewallType": "internet_firewall",
                "ConflictDetail": {
                    "ConflictType": "Same",
                    "ConflictRuleIDList": [
                        {
                            "Cover": true,
                            "RuleId": "7-be61-310222b7****"
                        }
                    ]
                }
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}

错误码

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

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

这个页面对您有帮助吗？

有用

无用