1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
查询多种条件的聚类分析
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeHistogram。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-shanghai 。 |
| FromTime | 是 | Timestamp | 起始时间 示例值：2019-12-30 00:00:00 |
| ToTime | 是 | Timestamp | 结束时间 示例值：2019-12-31 00:00:00 |
| QueryField | 是 | String | 聚类字段，ip为ip聚合，art为响应耗时聚合，url为url聚合，local为ip转化的城市聚合,qps为每秒请求数峰值的聚合，up为上行带宽峰值聚合，down为下行带峰值聚合 示例值：ip |
| Source | 是 | String | 条件，access为访问日志，attack为攻击日志 示例值：0 |
| Host | 否 | String | 兼容Host，逐步淘汰Host字段 示例值：www.test.com |
| Edition | 否 | String | 只有两个值有效，sparta-waf，clb-waf，不传则不过滤 示例值：clb-waf |
| InstanceID | 否 | String | WAF实例ID，不传则不过滤 示例值：waf_000q3t12p |
| Domain | 否 | String | 域名过滤，不传则不过滤，用于替代Host字段，逐步淘汰Host 示例值：waf.com |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Histogram | Array of String | 统计数据 示例值：[{"count":43,"ip":"128.14.129.10"}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询Bot数量
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHistogram
<公共请求参数>
{
"FromTime": "2024-11-03 00:00:00",
"ToTime": "2024-11-03 15:17:00",
"Host": "all",
"Source": "access",
"QueryField": "ip"
}输出示例
{
"Response": {
"Histogram": [
"{\"count\":43,\"ip\":\"128.14.129.10\"}",
"{\"count\":43,\"ip\":\"8.220.210.24\"}",
"{\"count\":42,\"ip\":\"185.191.126.248\"}",
"{\"count\":40,\"ip\":\"141.98.11.178\"}",
"{\"count\":33,\"ip\":\"9.190.110.251\"}"
],
"RequestId": "cce2cdd7-8e54-4c08-b669-648adb1b49c1"
}
}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 | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
