文档首页/ 边缘安全 EdgeSec/ API参考/ API/ HTTP防护规则管理-IP黑白名单/ 创建IP黑白名单规则
更新时间：2024-11-18 GMT+08:00
查看PDF
分享

创建IP黑白名单规则

功能介绍

创建IP黑白名单规则

URI

POST /v1/edgesec/configuration/http/policies/{policy_id}/blocktrustip-rule

表1 路径参数

参数

是否必选

参数类型

描述

policy_id

是

String

策略id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

auth token
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

规则名称

description

否

String

规则描述，最长512字符

addr

否

String

ip地址/地址段；ip地址/地址段或者ip地址组id至少有一个

white

是

Integer

  • 0：拦截

  • 1：放行

  • 2：仅记录

followed_action_id

否

String

攻击惩罚规则id

ip_group_id

否

String

ip地址组id；ip地址/地址段或者ip地址组id至少有一个

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

规则id

name

String

规则名称

policy_id

String

规则所在策略id

policy_name

String

规则所在策略名称

timestamp

Long

创建规则时间戳

description

String

规则描述

status

Integer

规则开关：

  • 0：关闭

  • 1：开启

addr

String

ip地址/地址段

white

Integer

  • 0：拦截

  • 1：放行

  • 2：仅记录

followed_action_id

String

攻击惩罚规则id

ip_group

HttpIpGroup object

ip地址组
表5 HttpIpGroup

参数

参数类型

描述

id

String

ip地址组id

name

String

ip地址组名称

ips

Array of strings

ip地址/地址段列表

size

Integer

ip地址/地址段大小

description

String

ip地址组描述

create_time

Long

ip地址组创建时间戳

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

标准化错误码：服务名.八位数字编码

error_msg

String

清晰的错误信息

encoded_authorization_message

String

对接IAM5.0的服务，拒绝访问时需要返回IAM的相关响应

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

标准化错误码：服务名.八位数字编码

error_msg

String

清晰的错误信息

encoded_authorization_message

String

对接IAM5.0的服务，拒绝访问时需要返回IAM的相关响应

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

标准化错误码：服务名.八位数字编码

error_msg

String

清晰的错误信息

encoded_authorization_message

String

对接IAM5.0的服务，拒绝访问时需要返回IAM的相关响应

请求示例

无

响应示例

无

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。