API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 云防火墙 > 入侵防御相关接口 > 查询入侵防御放通封禁列表

查询入侵防御放通封禁列表

最近更新时间：2024-03-12 01:16:07

我的收藏

本页目录：

1. 接口描述

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

查询入侵防御放通封禁列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeBlockIgnoreList。
Version 是 String 公共参数，本接口取值：2019-09-04。
Region 否 String 公共参数，本接口不需要传递此参数。
Limit 是 Integer 单页数量
示例值：10
Offset 是 Integer 页偏移量
示例值：0
Direction 是 String 方向：1互联网入站，0互联网出站，3内网，空 全部方向
示例值：1
Order 是 String 排序类型：desc降序，asc正序
示例值：desc
By 是 String 排序列：EndTime结束时间，StartTime开始时间，MatchTimes命中次数
示例值：EndTime
SearchValue 否 String 搜索参数，json格式字符串，空则传"{}"，域名：domain，危险等级：level，放通原因：ignore_reason，安全事件来源：rule_source，地理位置：address，模糊搜索：common
示例值：{"service_type":"1","service_name":""}
RuleType 否 Integer 规则类型：1封禁，2放通
示例值：block
ShowType 否 String blocklist 封禁列表
whitelist 白名单列表
示例值：blocklist

3. 输出参数

参数名称 类型 描述
Data Array of BlockIgnoreRule 列表数据
Total Integer 查询结果总数，用于分页
示例值：100
ReturnCode Integer 状态值，0：查询成功，非0：查询失败
示例值：0
ReturnMsg String 状态信息，success：查询成功，fail：查询失败
示例值：success
SourceList Array of String 安全事件来源下拉框
RuleTypeDataList Array of Integer 对应规则类型的数量，示例：[0,122,30,55,12,232,0]，封禁0个，IP地址122个，域名30个，威胁情报55个，资产实例12个，自定义策略232个，入侵防御规则0个
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询入侵防御放通封禁列表

查询入侵防御放通封禁列表

输入示例

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

{
    "Limit": 0,
    "Offset": 0,
    "SearchValue": "abc",
    "Direction": "abc",
    "RuleType": 1,
    "Order": "abc",
    "By": "abc"
}

输出示例

{
    "Response": {
        "Data": [
            {
                "RuleType": 0,
                "Ioc": "abc",
                "IocInfo": "abc",
                "Domain": "abc",
                "IP": "abc",
                "Level": "abc",
                "EventName": "abc",
                "Direction": 0,
                "DirectionList": "0,1",
                "Protocol": "abc",
                "Address": "abc",
                "Action": 0,
                "StartTime": "abc",
                "EndTime": "abc",
                "IgnoreReason": "abc",
                "Source": "abc",
                "UniqueId": "abc",
                "MatchTimes": 0,
                "Country": "abc",
                "Comment": "abc",
                "LastHitTime": "abc",
                "CustomRule": {
                    "SrcIP": "abc",
                    "DstIP": "abc",
                    "IdsRuleName": "abc",
                    "IdsRuleId": "abc"
                }
            }
        ],
        "Total": 0,
        "ReturnCode": 0,
        "ReturnMsg": "abc",
        "SourceList": [
            "abc"
        ],
        "RuleTypeDataList": [
            0,
            122,
            30,
            55,
            12,
            232,
            0
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
中国站