文档首页/ Web应用防火墙 WAF/ API参考 (巴黎) / API说明/ 云模式/ 黑白名单/ 创建IP黑白名单
更新时间：2022-02-22 GMT+08:00
查看PDF
分享

创建IP黑白名单

功能介绍

创建IP黑白名单。

URI

  • URI格式

    POST /v1/{project_id}/waf/policy/{policy_id}/whiteblackip

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

    名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

    用户操作的项目ID。

    policy_id

    是

    String

    策略ID。

请求消息

请求参数
表2 请求参数说明

名称

是否必选

参数类型

说明

addr

是

String

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

white

否

Integer

设置的IP地址类型。

  • “1” ：白（放行）。
  • “0”：黑（拦截）。

如果没有white字段表示黑IP，与white=0 效果相同。

响应消息

响应参数
表3 响应参数说明

名称

参数类型

说明

id

String

IP黑白名单规则的ID。

policy_id

String

策略ID。

addr

String

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

white

Integer

设置的IP地址类型。

  • “1” ：白（放行）。
  • “0”：黑（拦截）。

如果没有white字段表示黑IP，与white=0 效果相同。

timestamp

Long

创建IP黑白名单的时间。

示例

如下以创建IP白名单“X.X.0.125”为例。

  • 请求样例 
    {
    "addr": "X.X.0.125",
    "white": 1
}
  • 响应样例 
    {
  "id": "44d887434169475794b2717438f7fa78",
  "policy_id": "ertr45c0f96784ec8abd8ba61a98064ef",
  "addr": "X.X.0.125",
  "white": 1,
  "timestamp": 1499817600
}

状态码

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

状态码

编码

状态说明

200

OK

客户端请求已处理成功。

异常状态码，请参见状态码。

父主题： 黑白名单