1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
本接口用于检索分析日志,使用该接口时请注意如下事项:
- 该接口除受默认接口请求频率限制外,针对单个日志主题,查询并发数不能超过15。
- 检索语法建议使用日志服务专用检索语法CQL,请使用SyntaxRule参数,将值设置为1,控制台默认也使用该语法规则。
- API返回数据包最大49MB,建议启用 gzip 压缩(HTTP Request Header Accept-Encoding:gzip)。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SearchLog。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| From | 是 | Integer | 要检索分析的日志的起始时间,Unix时间戳(毫秒) 示例值:1608794854000 |
| To | 是 | Integer | 要检索分析的日志的结束时间,Unix时间戳(毫秒) 示例值:1608794855000 |
| Query | 是 | String | 检索分析语句,最大长度为12KB 示例值:protocol:HTTP |
| SyntaxRule | 否 | Integer | 检索语法规则,默认值为0,推荐使用1 。
详细说明参见检索条件语法规则 示例值:1 |
| TopicId | 否 | String |
示例值:cfw_netflow_border |
| Topics.N | 否 | Array of MultiTopicSearchInformation |
|
| Sort | 否 | String | 原始日志是否按时间排序返回;可选值:asc(升序)、desc(降序),默认为 desc
示例值:asc |
| Limit | 否 | Integer | 表示单次查询返回的原始日志条数,默认为100,最大值为1000。
可通过两种方式获取后续更多日志:
示例值:100 |
| Offset | 否 | Integer | 查询原始日志的偏移量,表示从第几行开始返回原始日志,默认为0。
示例值:0 |
| Context | 否 | String | 透传上次接口返回的Context值,可获取后续更多日志,总计最多可获取1万条原始日志,过期时间1小时。
示例值:Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy |
| SamplingRate | 否 | Float | 执行统计分析(Query中包含SQL)时,是否对原始日志先进行采样,再进行统计分析。 示例值:0.1 |
| UseNewAnalysis | 否 | Boolean | 为true代表使用新的检索结果返回方式,输出参数AnalysisRecords和Columns有效 示例值:false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Context | String | 透传本次接口返回的Context值,可获取后续更多日志,过期时间1小时。
示例值:Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy |
| ListOver | Boolean | 符合检索条件的日志是否已全部返回,如未全部返回可使用Context参数获取后续更多日志 示例值:false |
| Analysis | Boolean | 返回的是否为统计分析(即SQL)结果 示例值:false |
| Results | Array of LogInfo | 匹配检索条件的原始日志 注意:此字段可能返回 null,表示取不到有效值。 |
| ColNames | Array of String | 日志统计分析结果的列名 注意:此字段可能返回 null,表示取不到有效值。 示例值:["action"] |
| AnalysisResults | Array of LogItems | 日志统计分析结果 注意:此字段可能返回 null,表示取不到有效值。 |
| AnalysisRecords | Array of String | 日志统计分析结果 注意:此字段可能返回 null,表示取不到有效值。 示例值:["src_ip","dst_ip"] |
| Columns | Array of Column | 日志统计分析结果的列属性 注意:此字段可能返回 null,表示取不到有效值。 |
| SamplingRate | Float | 本次统计分析使用的采样率 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.1 |
| Topics | SearchLogTopics | 使用多日志主题检索时,各个日志主题的基本信息,例如报错信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询日志
查询protocol为HTTP的日志
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchLog
<公共请求参数>
{
"TopicId": "cfw_netflow_border",
"From": 1782131614167,
"To": 1782736414167,
"Query": "protocol:HTTP",
"SamplingRate": 1,
"SyntaxRule": 1,
"Limit": 1,
"Context": "",
"Sort": "desc",
"UseNewAnalysis": true
}
输出示例
{
"Response": {
"Analysis": false,
"Context": "Y29udGV4dC0wMmUyNmVmYi05OTZiLTQzNTctYTA1Ny03OGY1NmU3ZmRmNzUxNzgyNzM2NDc1NzE5",
"ListOver": false,
"RequestId": "e660b374-1538-4631-be77-c9a6e6680180",
"Results": [
{
"FileName": "",
"LogJson": "{\"instance_id\":\"ins-gke2r5e0\",\"src_ip\":\"119.**.**.112\",\"dst_ip\":\"103.**.**.115\",\"src_port\":56980,\"dst_port\":80,\"protocol\":\"HTTP\",\"direction\":0,\"dst_domain\":\"www.**.com\",\"in_pkt_count\":8,\"in_pkt_len\":2998,\"out_pkt_count\":8,\"out_pkt_len\":416,\"total_pkt_count\":16,\"total_pkt_len\":3414,\"ti_tag\":\"\",\"start_time\":\"2026-06-29 14:12:11\",\"end_time\":\"2026-06-29 14:12:24\",\"supplier\":\"baidu.com\",\"src_country\":\"\",\"dst_country\":\"中国\",\"src_province\":\"\",\"dst_province\":\"广东省\",\"src_city\":\"\",\"dst_city\":\"\",\"address\":\"广东省\",\"src_lat\":0,\"dst_lat\":0,\"src_lon\":0,\"dst_lon\":0,\"insert_time\":1782713553,\"count\":0,\"url\":\"\",\"domain_flag\":0,\"port_status\":0,\"level\":0,\"bot_flag\":0,\"mode\":1,\"tcp_flag\":31,\"timestamp\":\"2026-06-29 14:12:11\",\"is_serial\":1,\"pkt_flags\":\"0212101810\",\"pkt_dir\":\"01001\",\"action_src\":1,\"acl_uuid\":\"\",\"acl_rule_id\":0,\"acl_detail\":\"\"}",
"PkgId": "5229A51C7BECDA416A3E478F-00000000000579C7",
"PkgLogId": "29622640",
"RawLog": "",
"Time": 1782713531000,
"TopicId": "cfw_netflow_border"
}
],
"SamplingRate": 0
}
}
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 | 操作失败。 |
| FailedOperation.InvalidContext | FailedOperation.InvalidContext |
| FailedOperation.QueryError | FailedOperation.QueryError |
| FailedOperation.SearchTimeout | FailedOperation.SearchTimeout |
| FailedOperation.SyntaxError | FailedOperation.SyntaxError |
| FailedOperation.Timeout | FailedOperation.Timeout |
| FailedOperation.TopicIsolated | FailedOperation.TopicIsolated |
| InternalError | 内部错误。 |
| InternalError.SearchError | InternalError.SearchError |
| InternalError.SearchFailed | InternalError.SearchFailed |
| InternalError.ServerBusy | InternalError.ServerBusy |
| InvalidParameter | 参数错误。 |
| LimitExceeded.LogSearch | LimitExceeded.LogSearch |
| LimitExceeded.SearchResources | LimitExceeded.SearchResources |
| LimitExceeded.SearchResultTooLarge | LimitExceeded.SearchResultTooLarge |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccountDestroy | OperationDenied.AccountDestroy |
| OperationDenied.AccountIsolate | OperationDenied.AccountIsolate |
| OperationDenied.AccountNotExists | OperationDenied.AccountNotExists |
| OperationDenied.NewSyntaxNotSupported | OperationDenied.NewSyntaxNotSupported |
| OperationDenied.OperationNotSupportInSearchLow | OperationDenied.OperationNotSupportInSearchLow |
| ResourceNotFound.TopicNotExist | ResourceNotFound.TopicNotExist |