更新时间:2024-07-25 GMT+08:00

创建黑白名单规则

功能介绍

创建黑白名单规则

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户操作的项目id

policy_id

String

防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

内容类型

缺省值:application/json;charset=utf8

表4 请求Body参数

参数

是否必选

参数类型

描述

name

String

规则名称只能由字母、数字、-、_和.组成,长度不能超过64个字符

addr

String

黑白名单ip地址,需要输入标准的ip地址或地址段,例如:10.123.120.66或10.123.120.0/16

description

String

黑白名单规则描述

white

Integer

防护动作:

  • 0 拦截

  • 1 放行

  • 2 仅记录

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

id

String

规则id

policyid

String

策略id

addr

String

黑白名单ip地址,需要输入标准的ip地址或地址段,例如:10.123.120.66或10.123.120.0/16

white

Integer

防护动作:

  • 0 拦截

  • 1 放行

  • 2 仅记录

timestamp

Long

创建规则的时间戳,13位毫秒时间戳

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/whiteblackip?enterprise_project_id=0

{
  "name" : "demo",
  "white" : 0,
  "description" : "demo",
  "addr" : "x.x.x.x"
}

响应示例

状态码: 200

ok

{
  "id" : "5d43af25404341058d5ab17b7ba78b56",
  "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
  "name" : "demo",
  "timestamp" : 1650531872900,
  "description" : "demo",
  "status" : 1,
  "addr" : "x.x.x.x",
  "white" : 0,
  "size" : 1
}

状态码

状态码

描述

200

ok

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码