白名单规则 保存
更新时间：2026-03-10
POST
/v1/waf/whiteRules/save
白名单规则 保存
请求参数
Headers 参数
除公共头域外，无其它特殊头域
Body 参数
ruleName
string
规则名称
必选
ruleType
string
规则类型。可选值: saas, native
必选
targets
array
匹配条件，saas 与线上保持一致，native 时 传 IP belong
必选
显示子属性
隐藏子属性
items
object {4}
显示子属性
隐藏子属性
key
string
匹配字段
必选
field
string
特殊 匹配字段 可以 自定义字段名称
可选
match
string
匹配操作符
必选
value
array
字符串数组，匹配字段 为 empty、none、exists 时 传 空 字符串数组 [""]
必选
显示子属性
隐藏子属性
items
string
bindInfo
array
站点绑定信息
必选
显示子属性
隐藏子属性
items
object {2}
显示子属性
隐藏子属性
instanceID
string
必选
subdomains
array
必选
显示子属性
隐藏子属性
items
string
ruleKey
string
规则唯一标识，编辑时必传
可选
ignoreModules
array
不检测模块
必选
显示子属性
隐藏子属性
items
string
可选值: base, black_ip, web_tamper_protection, data_loss_prevention, bot, custom, rate_limit, region_block
ignoreIds
array
跳过检测规则ID
可选
显示子属性
隐藏子属性
items
string
请求结构
{
"ruleName": "规则名称",
"ruleType": "saas",
"targets": [
{
"key": "匹配字段",
"field": "自定义字段名称",
"match": "匹配操作符",
"value": ["匹配内容"]
}
],
"bindInfo": [
{
"instanceID": "实例ID",
"subdomains": ["子域名"]
}
],
"ruleKey": "规则唯一标识",
"ignoreModules": ["base"],
"ignoreIds": ["跳过检测规则ID"]
}示例代码
保存白名单规则的请求示例
curl -X POST "https://example.com/v1/waf/whiteRules/save" \
-H "Content-Type: application/json" \
-d '{
"ruleName": "测试白名单规则",
"ruleType": "saas",
"targets": [
{
"key": "ip",
"field": "",
"match": "equal",
"value": ["192.168.1.1"]
}
],
"bindInfo": [
{
"instanceID": "instance-001",
"subdomains": ["www.example.com"]
}
],
"ignoreModules": ["base", "bot"],
"ignoreIds": []
}'{
"ruleName": "测试白名单规则",
"ruleType": "saas",
"targets": [
{
"key": "ip",
"field": "",
"match": "equal",
"value": ["192.168.1.1"]
}
],
"bindInfo": [
{
"instanceID": "instance-001",
"subdomains": ["www.example.com"]
}
],
"ignoreModules": ["base", "bot"],
"ignoreIds": []
}返回响应
Headers 参数
除公共头域外，无其它特殊头域
返回参数
success
boolean
请求是否成功
必选
result
object {1}
必选
显示子属性
隐藏子属性
ruleKey
string
规则唯一标识
必选
白名单规则保存成功后的返回结果
成功响应示例
{
"success": true,
"result": {
"ruleKey": "rule-abc123456"
}
}