1. 接口描述
接口请求域名: waf.tencentcloudapi.com 。
api安全事件列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeApiSecEventList。 |
| Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。 |
| Domain | 是 | String | 域名 示例值:qcloudwaf.com |
| NeedTotalCount | 否 | Boolean | 是否查询数量,默认不查询,为true则进行查询 示例值:true |
| Filters.N | 否 | Array of ApiDataFilter | 过滤条件 |
| PageIndex | 否 | Integer | 查询当前的页 示例值:10 |
| PageSize | 否 | Integer | 每一页显示多少条数据 示例值:10 |
| Sort.N | 否 | Array of String | 排序,第一个元素为排序的key,第二个元素为排序规则,其中1 为升序排列,而-1 是用于降序排列 示例值:["timestamp","1"] |
| StartTs | 否 | Integer | 查询开始时间 示例值:123 |
| EndTs | 否 | Integer | 查询结束时间 示例值:3124 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of ApiEvent | 事件列表 注意:此字段可能返回 null,表示取不到有效值。 |
| Total | Integer | 事件总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 api安全事件列表
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApiSecEventList
<公共请求参数>
{
"Domain": "qcloudwaf.com"
}
输出示例
{
"Response": {
"RequestId": "cd63d5b2-9d4e-46db-8cfd-b1c448cc8e47",
"Data": [
{
"EventId": "api_asfa",
"EventType": "",
"Domain": "hzh.qcloud.com",
"Mode": "1",
"StartTime": 0,
"UpdateTime": 0,
"ApiName": "/api",
"Level": "400",
"Method": ""
}
],
"Total": 213
}
}
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 | 操作不支持。 |