自定义规则 保存
更新时间：2026-03-10
POST
/v1/waf/customRules/save
自定义规则 保存
请求参数
Headers 参数
除公共头域外，无其它特殊头域
Body 参数
ruleName
string
规则名称
必选
ruleType
string
规则类型。说明: saas、native
必选
action
string
处置动作。说明: log => 观察\ndeny => 拦截\nblock_forbidden => 追加封禁\npass => 放行
必选
targets
array
匹配目标列表
必选
显示子属性
隐藏子属性
items
object {4}
显示子属性
隐藏子属性
key
string
匹配字段
必选
field
string
自定义字段名称。说明: 特殊 匹配字段 可以 自定义字段名称
可选
match
string
匹配操作符
必选
value
array
匹配内容。说明: 字符串数组，匹配操作符 为 empty、none、exists 时 传 空 字符串数组 [""]
必选
显示子属性
隐藏子属性
items
string
bindInfo
array
绑定信息列表
必选
显示子属性
隐藏子属性
items
object {2}
显示子属性
隐藏子属性
instanceID
string
实例ID
必选
subdomains
array
子域名列表
必选
显示子属性
隐藏子属性
items
string
forbiddenTime
integer
追加封禁时间。说明: 单位：分钟，处置动作为 blockForbidden 时必填
可选
ruleKey
string
规则唯一标识。说明: 编辑时必传
可选
effectiveType
integer
生效模式。可选值: 0, 1, 2。说明: 0-永久生效, 1-按时间段生效, 2-按周期生效
必选
effectiveTime
object {3}
生效时段
可选
显示子属性
隐藏子属性
range
array
指定生效时间段
可选
显示子属性
隐藏子属性
items
object {2}
显示子属性
隐藏子属性
start
string
开始时间。格式: YYYY-MM-DD HH:mm:ss
必选
end
string
结束时间。格式: YYYY-MM-DD HH:mm:ss
必选
schedule
array
指定生效周期
必选
显示子属性
隐藏子属性
items
object {2}
显示子属性
隐藏子属性
days_of_week
array
星期类型数组
必选
显示子属性
隐藏子属性
items
integer
星期类型。可选值: 0, 1, 2, 3, 4, 5, 6。说明: 0-周日, 1-周一, 2-周二, 3-周三, 4-周四, 5-周五, 6-周六
range
object {2}
时间范围
必选
显示子属性
隐藏子属性
start
string
开始时间。格式: YYYY-MM-DD HH:mm:ss
必选
end
string
结束时间。格式: YYYY-MM-DD HH:mm:ss
必选
time_zone
integer
时区
必选
请求结构
{
"ruleName": "规则名称",
"ruleType": "saas",
"action": "log",
"targets": [
{
"field": "自定义字段名称",
"key": "cookie_cus",
"match": "include",
"value": ["匹配内容"]
}
],
"bindInfo": [
{
"instanceID": "实例ID",
"subdomains": ["域名"]
}
],
"forbiddenTime": 10,
"ruleKey": "规则唯一标识",
"effectiveType": 0,
"effectiveTime": {
"range": [
{
"start": "2026-02-24 08:59:59",
"end": "2026-02-24 08:59:59"
}
],
"schedule": [
{
"days_of_week": [1],
"range": {
"start": "2026-02-24 08:59:59",
"end": "2026-02-24 08:59:59"
}
}
],
"time_zone": 8
}
}示例代码
创建一个新的WAF自定义规则，设置为观察模式并绑定到指定实例
curl -X POST "https://{host}/v1/waf/customRules/save" \
-H "Content-Type: application/json" \
-d '{
"ruleName": "测试规则",
"ruleType": "saas",
"action": "log",
"targets": [
{
"key": "cookie_cus",
"match": "include",
"value": ["test_value"]
}
],
"bindInfo": [
{
"instanceID": "instance_id_123",
"subdomains": ["www.example.com"]
}
],
"effectiveType": 0
}'{
"ruleName": "测试规则",
"ruleType": "saas",
"action": "log",
"targets": [
{
"key": "cookie_cus",
"match": "include",
"value": ["test_value"]
}
],
"bindInfo": [
{
"instanceID": "instance_id_123",
"subdomains": ["www.example.com"]
}
],
"effectiveType": 0
}返回响应
Headers 参数
除公共头域外，无其它特殊头域
返回参数
success
boolean
请求是否成功
必选
result
object {1}
返回结果
必选
显示子属性
隐藏子属性
ruleKey
string
规则唯一标识
必选
规则保存成功后返回规则唯一标识
成功响应
{
"success": true,
"result": {
"ruleKey": "rule_123456789abcdef"
}
}