1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
获取Api安全模块的访问日志聚合topN
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeApiAggregateTopN。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。 |
| Domain | 是 | String | 域名 示例值：www.qcloudwaf.com |
| TopN | 是 | Integer | 需要的Top数，默认5， 最大值100 示例值：10 |
| StartTs | 是 | Integer | 开始时间 示例值：1224256678 |
| EndTs | 是 | Integer | 结束时间 示例值：1224256679 |
| Dimension | 是 | String | 需要查询TOP的维度名 示例值：ip |
| Filters.N | 否 | Array of BotDataFilter | 过滤条件 |
| GlobalFlag | 否 | Boolean | 是否查询全域名的三个特殊图标 示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of BotTopItem | topN结果 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取Api安全模块的访问日志聚合topN
示例描述
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApiAggregateTopN
<公共请求参数>
{
"TopN": "5",
"Domain": "hzh.qcloud.com",
"StartTs": "666123231",
"EndTs": "666123156",
"Dimension": "attack_type"
}输出示例
{
"Response": {
"RequestId": "02e6870f-89b6-4e7b-b738-942ef9bfd1e5",
"Data": [
{
"Key": "luffy",
"Value": 100,
"Label": "custom"
}
]
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| UnsupportedOperation | 操作不支持。 |
