帮你快速理解、总结文档立即下载
文档中心>云防火墙>API 文档>AI安全场景相关接口>查询防火墙分析报告数据

查询防火墙分析报告数据

最近更新时间：2026-07-21 01:27:28

我的收藏

本页目录：

1. 接口描述

接口请求域名： cfw.tencentcloudapi.com 。

查询当前租户防火墙分析报告数据。按分析场景返回整组分析结果，结果在 Response.Data 的 JSON 字符串中。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeCfwAnalysisData。
Version 是 String 公共参数，本接口取值：2019-09-04。
Region 否 String 公共参数，本接口不需要传递此参数。
Scenario 是 String 分析场景。必填。full_traffic 表示全流量深度分析；east_west 表示东西向流量分析；alert_comprehensive 表示告警综合分析；asset_exposure 表示资产暴露面分析；access_troubleshoot 表示访问阻断排障分析。
示例值：full_traffic
StartTime 否 String 查询开始时间。可选，格式 YYYY-MM-DD HH:MM:SS；不传时默认查询最近 7 天。
示例值：2026-07-09 00:00:00
EndTime 否 String 查询结束时间。可选，格式 YYYY-MM-DD HH:MM:SS；不传时默认当前时间。
示例值：2026-07-09 01:00:00
ObjectType 否 String 分析对象类型。可选，默认 user；user 表示租户全局，asset 表示资产上下文，vpc 表示 VPC 上下文，domain 表示域名上下文。选择非 user 时建议同时传 ObjectId 以限定具体对象；当前未传 ObjectId 时仍按该对象类型执行宽查询。
示例值：asset
ObjectId 否 String 分析对象标识。ObjectType 为 asset、vpc 或 domain 时可传，用于限定具体 IP、实例 ID、VPC ID 或域名；当前为可选参数，省略时不会按具体对象过滤。
示例值：cdb-i6zh3mwf
Target 否 String 目标 IP 或域名过滤。可选，常用于 access_troubleshoot，也可用于其他 Scenario；传入后优先于 ObjectType/ObjectId，并对该场景全部分析段追加源 IP、目的 IP 或目的域名过滤。
示例值：10.199.32.12
SkipSections.N 否 Array of String 需要跳过的分析段名称列表。可选；不传或传空数组时执行该场景全部分析段。full_traffic 支持 beacon、dns_large、dns_dga、dns_dga_fine、dns_tunnel、icmp_tunnel、mining、p2p、remote_tool、file_transfer、high_risk_outbound、lateral_baseline、vpc_sensitive、smb_write、outbound_baseline、inbound_high_risk、tls_expired、tls_self_signed、first_seen_ip、first_seen_country、first_seen_port；east_west 支持 vpc_inter_vpc、subnet_inter、service_port、lateral_baseline、vpc_sensitive、smb_write、database_lateral；alert_comprehensive 支持 outbound_baseline、lateral_baseline、beacon、inbound_high_risk、first_seen_ip、first_seen_country、first_seen_port；asset_exposure 支持 inbound_high_risk、tls_expired、tls_self_signed、high_risk_outbound；access_troubleshoot 支持 acl_border_block、acl_nat_block、acl_vpc_block、ips_block。传入当前 Scenario 不支持的名称会返回 InvalidParameter。
示例值：["ips_block"]

3. 输出参数

参数名称 类型 描述
Data String 查询结果。Response.Data 是 UTF-8 JSON object 字符串，调用方需要二次 JSON 解析。status 取值为 success、partial 或 error。section 查询失败时，error 只返回固定安全摘要，不包含底层服务内部信息。示例仅展示一个代表性 section；实际返回包含当前场景全部未跳过的 section；summary 包含 total_findings、high_risk_count 和 data_coverage，metadata 包含 scenario、time_range、object 和 query_stats，query_stats 包含 total_queries、successful 和 failed。
示例值：{"status":"success","scenario":"full_traffic","object":"user","time":"00:00~01:00","queries":"21/21 ok","findings":0,"sections":"none"}
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询全流量分析报告数据

按 full_traffic 场景返回防火墙分析报告数据；示例仅展示一个代表性 section，业务结果在 Response.Data 中。

输入示例

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

{
    "Scenario": "full_traffic",
    "StartTime": "2026-06-01 00:00:00",
    "EndTime": "2026-06-02 00:00:00"
}

输出示例

{
    "Response": {
        "Data": "{\"status\":\"success\",\"data\":{\"sections\":{\"beacon\":{\"available\":true,\"records\":[{\"src_ip\":\"10.0.0.1\"}]}}},\"metadata\":{\"scenario\":\"full_traffic\"}}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

示例2 按目标排查访问阻断

Target 对该场景全部分析段追加目标过滤；SkipSections 可跳过不需要或已知不可用的分析段。输出仅展示一个代表性 section，实际返回全部未跳过的 section。

输入示例

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

{
    "Scenario": "access_troubleshoot",
    "Target": "10.0.0.1",
    "SkipSections": [
        "ips_block"
    ]
}

输出示例

{
    "Response": {
        "Data": "{\"status\":\"success\",\"data\":{\"sections\":{\"acl_border_block\":{\"available\":true,\"records\":[]}}},\"metadata\":{\"scenario\":\"access_troubleshoot\",\"object\":{\"type\":\"user\"}}}",
        "RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ResponseTooLarge FailedOperation.ResponseTooLarge
InternalError 内部错误。
InvalidParameter 参数错误。
中国站