文档中心>云防火墙>API 文档>其他接口>批量添加入侵防御封禁列表、放通列表规则

批量添加入侵防御封禁列表、放通列表规则

最近更新时间:2024-11-04 13:32:47

我的收藏

1. 接口描述

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

批量添加入侵防御封禁列表、放通列表规则

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateBlockIgnoreRuleList。
Version String 公共参数,本接口取值:2019-09-04。
Region String 公共参数,本接口不需要传递此参数。
Rules.N Array of IntrusionDefenseRule 规则列表
示例值:[{"Comment":"autotest-add","Direction":1,"Domain":" ","EndTime":"2024-11-08 03:13:31","IP":"7.7.7.7"}]
RuleType Integer 规则类型,1封禁,2放通,不支持域名封禁
示例值:1
CoverDuplicate Integer 是否覆盖重复数据,1覆盖,非1不覆盖,跳过重复数据
示例值:1

3. 输出参数

参数名称 类型 描述
List Array of IocListData 成功返回
示例值:[{"IP":"7.7.7.7","Domain":"","Direction":1}]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 添加封禁

添加封禁

输入示例

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

{
    "Rules": [
        {
            "IP": "1.1.1.1",
            "Direction": 1,
            "EndTime": "2025-01-01 00:00:00",
            "Comment": "阻断访问",
            "StartTime": "2024-10-10 00:00:00"
        }
    ],
    "RuleType": 1
}

输出示例

{
    "Response": {
        "List": [
            {
                "IP": "1.1.1.1",
                "Direction": 1
            }
        ],
        "RequestId": "e7c8de24-958f-4200-9d30-ddd186d6ee48"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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