文档中心>云防火墙>API 文档>入侵防御相关接口>告警中心-封禁、放通处置接口

告警中心-封禁、放通处置接口

最近更新时间:2024-11-01 01:14:46

我的收藏

1. 接口描述

接口请求域名: cfw.tencentcloudapi.com 。

用户告警中心-封禁、放通处置按钮

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAlertCenterRule。
Version String 公共参数,本接口取值:2019-09-04。
Region String 公共参数,本接口不需要传递此参数。
HandleTime Integer 处置时间
1 1天
7 7天
-2 永久
示例值:7
HandleType Integer 处置类型
当HandleIdList 不为空时:1封禁 2放通
当HandleIpList 不为空时:3放通 4封禁
示例值:1
AlertDirection Integer 当前日志方向: 0 出向 1 入向
示例值:1
HandleDirection String 处置方向: 0出向 1入向 0,1出入向 3内网
示例值:1
HandleIdList.N Array of String 处置对象,ID列表, IdLists和IpList二选一
示例值:["a67d60bb5ede9b962ac19ad24b28be54"]
HandleIpList.N Array of String 处置对象,IP列表, IdLists和IpList二选一
示例值:["192.155.90.220"]
HandleComment String 处置描述
示例值:block malware
IgnoreReason Integer 放通原因:
0默认 1重复 2误报 3紧急放通
示例值:1
BlockDomain String 封禁域名-保留字段
示例值:www.qq.com

3. 输出参数

参数名称 类型 描述
ReturnCode Integer 返回状态码:
0 成功
非0 失败
示例值:0
ReturnMsg String 返回信息:
success 成功
其他
示例值:success
Status Integer 处置状态码:
0 处置成功
-1 通用错误,不用处理
-3 表示重复,需重新刷新列表
其他
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 攻击告警汇总示例

攻击告警汇总-封禁IP示例

输入示例

POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlertCenterRule
<公共请求参数>

{
    "HandleIdList": [
        "a67d60bb5ede9b962ac19ad24b28be54"
    ],
    "HandleTime": 7,
    "HandleType": 1,
    "AlertDirection": 1,
    "HandleDirection": "1",
    "HandleComment": "处置描述"
}

输出示例

{
    "Response": {
        "RequestId": "9cddfe10-cbf2-4dd8-ba39-dd8488bb8a42",
        "ReturnCode": 0,
        "ReturnMsg": "success",
        "Status": 0
    }
}

示例2 攻击拦截统计示例

攻击拦截统计-封禁IP示例

输入示例

POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlertCenterRule
<公共请求参数>

{
    "HandleIpList": [
        "192.155.90.220"
    ],
    "HandleTime": 7,
    "HandleType": 3,
    "AlertDirection": 0,
    "HandleDirection": "0",
    "HandleComment": "处置描述"
}

输出示例

{
    "Response": {
        "RequestId": "9ff0c548-66c4-4989-8e6e-c616a1340d84",
        "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。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码