更新时间:2022-02-22 GMT+08:00

查询IP黑白名单列表

功能介绍

查询IP黑白名单列表。

URI

  • URI格式

    GET /v1/{project_id}/waf/policy/{policy_id}/whiteblackip?offset={offset}&limit={limit}

  • 参数说明
    表1 Path参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    用户操作的项目ID。

    policy_id

    String

    策略ID

    offset

    Long

    指定返回的页数,取值范围为:[0, 65535],默认值为0。

    limit

    Long

    指定查询返回每页记录的最大条数,取值范围为:(0, 50],默认值为10。

请求消息

请求参数

响应消息

响应参数
表2 响应参数说明

名称

参数类型

说明

total

Integer

规则总数量。

items

表3

IP黑白名单对象列表。

表3 items

名称

参数类型

说明

id

String

IP黑白名单规则的ID。

policy_id

String

IP黑白名单规则的策略ID。

addr

String

公网IP地址,例如:X.X.0.125、子网X.X.6.0/24。

white

Integer

设置的IP地址类型。

  • “1” :白(放行)。
  • “0”:黑(拦截)。

timestamp

Long

创建IP黑白名单的时间。

示例

如下以查询IP黑白名单列表,返回记录条数为“2”为例。

响应样例
{
  "total": 2,
  "items": [{
      "id": "3a9b5c0f96784ec8abd8ba61a98064ef",
      "policy_id": "ertr45c0f96784ec8abd8ba61a98064ef",
      "addr": "X.X.0.125",
      "white": 1,
      "timestamp": 1499817600
    }, {
      "id": "44d887434169475794b2717438f7fa78",
      "policy_id": "ertr45c0f96784ec8abd8ba61a98064ef",
      "addr": "X.X.0.125",
      "white": 0,
      "timestamp": 1499817601
    }
  ]
}

状态码

表4描述的是API返回的正常状态码。
表4 状态码

状态码

编码

状态说明

200

OK

客户端请求已处理成功。

异常状态码,请参见状态码