1. 接口描述
接口请求域名： cdn.tencentcloudapi.com 。
查询BOT会话记录列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeScdnBotRecords。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-06。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| BotType | 是 | String | BOT类型，取值为"UB","UCB","TCB"，分别表示：未知类型，自定义类型，公开类型 示例值：UB |
| Domain | 是 | String | 域名 示例值：www.test.com |
| StartTime | 是 | Timestamp | 开始时间 示例值：2021-02-01 00:00:00 |
| EndTime | 是 | Timestamp | 结束时间 示例值：2021-02-02 00:00:00 |
| Offset | 是 | Integer | 分页参数 示例值：0 |
| Limit | 是 | Integer | 分页参数 示例值：10 |
| Area | 是 | String | mainland 大陆地区 overseas境外地区 示例值：overseas |
| SortBy.N | 否 | Array of BotSortBy | 排序参数 |
| FilterName | 否 | String | BotType=UB时，表示需要过滤的预测标签，取值如下： "crawler_unregular", "crawler_regular", "request_repeat", "credential_miss_user", "credential_without_user", "credential_only_action", "credential_user_password", "credential_cracking", "credential_stuffing", "brush_sms", "brush_captcha", "reg_malicious" BotType=TCB时，表示需要过滤的Bot分类，取值如下： "Uncategorised", "Search engine bot", "Site monitor", "Screenshot creator", "Link checker", "Web scraper", "Vulnerability scanner", "Virus scanner", "Speed tester", "Feed Fetcher", "Tool", "Marketing" BotType=UCB时，取值如下： User-Agent为空或不存在 User-Agent类型为BOT User-Agent类型为HTTP Library User-Agent类型为Framework User-Agent类型为Tools User-Agent类型为Unkonwn BOT User-Agent类型为Scanner Referer空或不存在 Referer滥用(多个UA使用相同Referer) Cookie滥用(多个UA使用相同Cookie) Cookie空或不存在 Connection空或不存在 Accept空或不存在 Accept-Language空或不存在 Accept-Enconding空或不存在 使用HTTP HEAD方法 HTTP协议为1.0或者更低 IDC-IP 腾讯云 IDC-IP 阿里云 IDC-IP 华为云 IDC-IP 金山云 IDC-IP UCloud IDC-IP 百度云 IDC-IP 京东云 IDC-IP 青云 IDC-IP Aws IDC-IP Azure IDC-IP Google 以上所有类型，FilterName为空时，表示不过滤，获取所有内容 示例值：crawler_unregular |
| FilterAction | 否 | String | 目前支持的Action "intercept" 拦截 "monitor"，监控 "permit" 放行 "redirect" 重定向 尚未支持的Action "captcha" 验证码 示例值：intercept |
| FilterIp | 否 | String | 过滤的IP 示例值：8.8.8.8 |
| Domains.N | 否 | Array of String | 域名列表，为空表示查询AppID维度数据 示例值：[www.test.com] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of BotRecord | BOT拦截结果数组 |
| TotalCount | Integer | 记录数量 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取指定类型的BOT记录
输入示例
https://cdn.tencentcloudapi.com/?Action=DescribeScdnBotRecords
&BotType=TCB
&Domain=123.com
&StartTime=2020-04-20 12:00:00
&EndTime=2020-04-20 23:59:59
&Offset=0
&Limit=20
&SortBy.0.Key=timestamp
&SortBy.0.Sequence=desc
&Area=overseas
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 0,
"Data": [],
"RequestId": "6d04373b-ba59-4a4f-a96e-9fe53b59a536"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.CdnConfigError | 域名配置更新失败。 |
| InternalError.Error | 内部服务错误，请联系腾讯云工程师进一步排查。 |
| InternalError.SystemDBError | 内部数据错误，请重试或联系客服人员解决。 |
| UnauthorizedOperation.CdnCamUnauthorized | 子账号未配置cam策略。 |
| UnauthorizedOperation.ClsInvalidAuthorization | 无效的授权。 |
| UnauthorizedOperation.ClsUnauthorized | 授权未通过。 |
