1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
忽略告警中心或拦截列表中的记录。忽略操作不支持撤销。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateAlertCenterOmit。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| HandleIdList.N | 是 | Array of String | 要忽略的记录 ID 列表。TableType=AlertTable 时,使用 DescribeLogs(Index=rule_threatinfo)返回的 log_id;仅通过 HandleEventIdList 指定事件时传 [""]。TableType=InterceptionTable 时,使用 DescribeBlockList 返回的 Data[].UniqueId 或 TopData[].UniqueId。 示例值:["a67d60bb5ede9b962ac19ad24b28be54"] |
| TableType | 是 | String | 必填的记录来源类型:AlertTable 表示告警中心,InterceptionTable 表示拦截列表。 示例值:AlertTable |
| CfwAiAgentOperationSource | 否 | String | AI操作来源 枚举值:
示例值:console |
| HandleEventIdList.N | 否 | Array of String | 告警事件 ID 列表,可省略且仅用于 TableType=AlertTable。HandleEventIdList 与 HandleIdList 至少指定一种目标;仅按事件忽略时,HandleIdList 固定传 [""]。事件 ID 通过 DescribeCfwAlerts 获取,返回 alerts[].current_event_id 时使用该值,否则使用 alerts[].event_id。 示例值:["event-id-from-DescribeCfwAlerts"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReturnCode | Integer | 请求返回码,0 表示请求已执行;忽略结果见 Status。 示例值:0 |
| ReturnMsg | String | 与 ReturnCode 对应的结果信息,成功时为 success。 示例值:success |
| Status | Integer | 忽略处理状态,0 表示成功,非 0 表示未成功。 示例值:0 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 忽略新告警中心事件
按 DescribeCfwAlerts 返回的事件 ID 忽略告警事件;存在 alerts[].current_event_id 时使用该值,否则使用 alerts[].event_id。HandleIdList 固定传 [""]。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlertCenterOmit
X-TC-Version: 2019-09-04
{
"HandleIdList": [
""
],
"TableType": "AlertTable",
"HandleEventIdList": [
"00000000000000000000000000000001"
]
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000001",
"ReturnCode": 0,
"ReturnMsg": "success",
"Status": 0
}
}
示例2 忽略告警日志
按 DescribeLogs 返回的 log_id 忽略告警中心记录。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlertCenterOmit
X-TC-Version: 2019-09-04
{
"HandleIdList": [
"00000000000000000000000000000002"
],
"TableType": "AlertTable"
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000002",
"ReturnCode": 0,
"ReturnMsg": "success",
"Status": 0
}
}
示例3 忽略拦截记录
按 DescribeBlockList 返回的 Data[].UniqueId 或 TopData[].UniqueId 忽略拦截记录。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlertCenterOmit
X-TC-Version: 2019-09-04
{
"HandleIdList": [
"00000000000000000000000000000003"
],
"TableType": "InterceptionTable"
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000003",
"ReturnCode": 0,
"ReturnMsg": "success",
"Status": 0
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。