1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
查询当前租户防火墙日志。分页只使用 Response.Data 内的 HasMore / NextToken。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCfwLogs。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| LogType | 否 | String | 日志类型。首次查询必填;使用 NextToken 续查时不能传。cfw_netflow_border=互联网边界流量,cfw_netflow_vpc=VPC 东西向流量,cfw_netflow_nat=NAT 防火墙流量,cfw_netflow_nta=NDR/NTA 流量,cfw_netflow_dns=DNS 防火墙日志,cfw_rule_threatinfo=入侵防御/威胁情报告警,cfw_rule_acl=互联网边界访问控制日志,cfw_rule_vpc_acl=VPC 访问控制日志,cfw_rule_nat_acl=NAT 访问控制日志,cfw_ndr_subject_risk=NDR 专题风险,cfw_ndr_dataleak_entry=NDR 敏感数据泄露,cfw_ndr_ai_audit=NDR AI 应用识别与大模型调用审计,cfw_feature_collect=统计特征与基线异常,cfw_behavior_collect=Beacon/DNS/端口/证书/VPC 互访行为,operate_log_all=操作审计日志。 示例值:cfw_netflow_border |
| Query | 否 | String | 日志过滤表达式。默认 * 表示不过滤;例如 src_ip:1.1.1.1。可查询字段随 LogType 变化,应优先使用对应 Items 中已返回的字段名,不要猜测不存在的字段;使用 NextToken 续查时不能传。 示例值:src_ip:1.1.1.1 |
| StartTime | 否 | String | 查询起始时间。支持 RFC3339、YYYY-MM-DD HH:MM:SS、YYYY-MM-DD 或 Unix 时间戳;传入后从该时间向后查询 TimeRange;使用 NextToken 续查时不能传。 示例值:2026-07-09T02:00:00Z |
| TimeRange | 否 | String | 查询时间范围。默认 1h;格式为正整数加单位 m/h/d,例如 5m、1h、24h、7d;使用 NextToken 续查时不能传。 示例值:1h |
| Limit | 否 | Integer | 单页返回条数。首次查询可选,默认 100;取值 1 至 1000;使用 NextToken 续查时不能传。 示例值:10 |
| NextToken | 否 | String | 上一页 Response.Data 返回的不透明续查 token。首次查询不传;续查时只传 NextToken。无效、篡改或租户不匹配会被拒绝。 示例值:ezylgj87Z1uDirOl6dgt2xAt3siE3dyZDFsaZ7x3COpcgQ6hntYVSz2ZxhuL2DDUkpdn3DAbid1rqI242sSER3YmvUOGuoFy-QfzS30eeVCQBfQ98-OlUMxHOIsSu0XLw9BeOLh7VrlK7AmZMpF5g-AfRSoNu_-En2LSXGWMxWVaNNt56KDeCKfotoHRUGl_SGEUEVLCNq31UOGJMaeWiFBkXxQt_30aJa3PpLHUC2U48SmJb9_jsS7Yh6m9FB8c |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | String | 查询结果。UTF-8 JSON object 字符串;调用方需解析 Response.Data。Items 是当前页日志数组,字段随 LogType 变化;TotalCount 是当前页返回条数,Limit 是页大小,LogType 和 TimeWindow 回显查询范围。HasMore=true 时必须保存并原样使用 NextToken 续查;HasMore=false 时分页结束。 示例值:{"HasMore":false,"IsAnalysis":false,"Items":null,"Limit":10,"LogType":"cfw_netflow_border","Query":"src_ip:1.1.1.1","TimeWindow":{"EndTime":"2026-07-09T13:40:00Z","StartTime":"2026-07-09T12:40:00Z"},"TotalCount":0} |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 首次查询防火墙日志
首次查询传入 LogType;如果 Data.HasMore 为 true,保存 Data.NextToken 用于续查。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfwLogs
<公共请求参数>
{
"LogType": "cfw_netflow_border",
"Query": "src_ip:1.1.1.1",
"TimeRange": "1h",
"Limit": 100
}
输出示例
{
"Response": {
"Data": "{\"Items\":[{\"src_ip\":\"1.1.1.1\"}],\"TotalCount\":1,\"Limit\":100,\"HasMore\":true,\"NextToken\":\"opaque-token\"}",
"RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
}
}
示例2 使用 NextToken 续查
续查只回传 NextToken;调用方不要解析或构造 token。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfwLogs
<公共请求参数>
{
"NextToken": "opaque-token"
}
输出示例
{
"Response": {
"Data": "{\"Items\":[],\"TotalCount\":0,\"Limit\":100,\"HasMore\":false}",
"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。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ResponseTooLarge | FailedOperation.ResponseTooLarge |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |