ListProhibition-查询封禁 IP 信息--Web应用防火墙-火山引擎

文档中心

立即注册

导航

ListProhibition-查询封禁 IP 信息

最近更新时间：2024.03.01 16:47:38首次发布时间：2023.11.10 18:24:48

查询符合条件的封禁 IP 列表信息，包括攻击源 IP、攻击次数和 IP 状态等信息。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListProhibition&Version=2020-12-09

请求参数

参数	类型	是否必填	示例值	描述
StartTime	String	是	`1696830193`	起始时间。Unix 秒级时间戳，EndTime 要大于StartTime。
EndTime	String	是	`1696920201`	结束时间。Unix 秒级时间戳，EndTime 要大于StartTime。
Reason	Array of strings	否	`["black","httpflood"]`	攻击类型筛选。如果攻击类型为空，则查询所有攻击类型封禁的 IP。 black：访问黑名单。 geo_black：地理位置访问控制。 httpflood：CC 攻击。 web_vulnerability：Web 漏洞攻击 bot：Bot 攻击 sensitive_info：敏感信息泄露 route_abnormal：API 路由异常 param_abnormal：API 参数异常
Host	String	是	`example.volcwaf001.com`	需要查询的网站域名。
LetterOrderBy	String	否	`ASC`	列表显示顺序。 ASC：按攻击源 IP 升序。 DESC：按攻击源 IP 降序。
Page	Integer	是	`1`	查询页码，默认为 1。
PageSize	Integer	是	`20`	单页条数，默认为 10。范围为 1～100。

返回参数

参数	类型	示例值	描述
TotalCount	Integer	`15`	查询到的符合条件的条目总数。
PageSize	Integer	`20`	单个页面显示的条目数量上限。
CurrentPage	Integer	`1`	当前页面的页码。
Count	Integer	`10`	当前页面显示的条目数量。
IpAggGroup	Array of IpAggGroup objects		攻击 IP 详情。

IpAggGroup

参数	类型	示例值	描述
Ip	String	`1.1.1.1`	攻击源 IP。
DropCount	Integer	`67243`	该攻击源 IP 的攻击次数。
Reason	Array of strings	`["httpflood": 60197, "web_vulnerability": 7046]`	不同攻击类型对应的攻击次数。 black：访问黑名单。 geo_black：地理位置访问控制。 httpflood：CC 攻击。 web_vulnerability：Web 漏洞攻击 bot：Bot 攻击 sensitive_info：敏感信息泄露 route_abnormal：API 路由异常 param_abnormal：API 参数异常
Status	Integer	`0`	IP 封禁状态。 0：未处理 1：永久加白 2：取消加白 3：永久封禁 4：取消封禁
UpdateTime	String	`2023-10-10T14:59:29+08:00`	状态更新时间。
RuleTag	String	`A000000004122`	封禁规则 ID。
RuleName	String	`封禁管理快速添加_20231010144648`	封禁规则名称。

请求示例

POST https://open.volcengineapi.com/?Action=ListProhibition&Version=2020-12-09
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

{
  "StartTime": 1696830193,
  "EndTime": 1696920201,
  "Reason": [
    "black"
  ],
  "Host": "example.volcwaf001.com",
  "LetterOrderBy": "ASC",
  "Page": 1,
  "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231013200325B13637DF46E9C7D0****",
        "Action": "ListProhibition",
        "Version": "2020-12-09",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 1,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 1,
        "IpAggGroup": [
            {
                "Ip": "19.252.**.**",
                "DropCount": 6806,
                "Reason": {
                    "web_vulnerability": 6806
                },
                "Status": 2,
                "UpdateTime": "2023-10-10T14:59:29+08:00",
                "RuleTag": "A000000004122",
                "RuleName": "封禁管理快速添加_20231010144648"
            },
            {
                "Ip": "19.252.**.**",
                "DropCount": 37820,
                "Reason": {
                    "web_vulnerability": 37820
                },
                "Status": 4,
                "UpdateTime": "2023-10-10T15:14:28+08:00",
                "RuleTag": "B000000025959",
                "RuleName": "封禁管理快速添加_20231010150810"
            }
        ]
    }
}