1. 接口描述
接口请求域名: waf.tencentcloudapi.com 。
新版本CLS接口存在参数变化,query改成了query_string支持lucence语法接口搜索查询。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SearchAttackLog。 |
Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-shanghai 。 |
Domain | 是 | String | 查询的域名,所有域名使用all 示例值: waf.com |
StartTime | 是 | Timestamp | 查询起始时间 示例值: 2024-10-29 20:49:24 |
EndTime | 是 | Timestamp | 查询结束时间 示例值: 2024-10-29 20:49:28 |
Context | 是 | String | 接口升级,这个字段传空字符串,翻页使用Page字段 示例值:cont |
QueryString | 是 | String | Lucene语法 示例值:bot:1 |
Count | 否 | Integer | 查询的数量,默认10条,最多100条 示例值: 10 |
Sort | 否 | String | 默认为desc,可以取值desc和asc 示例值: desc |
Page | 否 | Integer | 第几页,从0开始 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Count | Integer | 当前返回的攻击日志条数 示例值: 20 |
Context | String | 接口升级,此字段无效,默认返回空字符串 示例值:cont |
Data | Array of AttackLogInfo | 攻击日志数组条目内容 示例值: "{"action":1,"args_name":"HTTP Header"}" |
ListOver | Boolean | CLS接口返回内容 示例值: true |
SqlFlag | Boolean | CLS接口返回内容,标志是否启动新版本索引 示例值: true |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 搜索攻击日志详情内容
搜索攻击日志详情内容
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchAttackLog
<公共请求参数>
{
"Domain": "all",
"StartTime": "2024-10-28 20:56:07",
"EndTime": "2024-10-29 20:56:07",
"QueryString": "bot:1",
"Context": "cont",
"Sort": "desc",
"Count": 10,
"Page": 0
}
输出示例
{
"Response": {
"Count": 1,
"Context": "cont",
"ListOver": false,
"SqlFlag": false,
"Data": [
{
"Content": "{\"action\":1,\"args_name\":\"HTTP Header\"}",
"FileName": "name",
"Source": "sre",
"TimeStamp": "2020-09-22 00:00:00"
}
],
"RequestId": "ead32d5d-a9ac-496f-b8e3-d3a92f1fb1ce"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.CLSDBOperationFailed | 调用CLS日志服务API失败 |
FailedOperation.CLSInternalError | CLS内部错误。 |
InternalError | 内部错误。 |
InternalError.UnknownErr | 存在内部错误,请联系我们 |
InvalidParameter.LogicErr | 逻辑错误:SQL检索语句中的逻辑错误也可能导致错误。例如,使用错误的运算符、使用错误的条件等 |
InvalidParameter.QueryStringSyntaxErr | 语法错误:逻辑表达式语法解析出错 |
InvalidParameter.TypeMismatch | 数据类型错误:SQL检索语句中的数据类型必须与数据库中的数据类型匹配,否则会导致错误。例如,将字符串与整数进行比较、将日期格式不正确等。 |
UnsupportedOperation | 操作不支持。 |