自定义规则 列表
更新时间：2026-03-10
POST
/v1/waf/customRules/list
自定义规则 列表
请求参数
Headers 参数
除公共头域外，无其它特殊头域
Body 参数
pageNo
integer
必选
pageSize
integer
必选
action
string
可选
switch
integer
可选
subdomain
array
可选
显示子属性
隐藏子属性
items
string
ruleID
string
可选
ruleName
string
规则名称筛选
可选
请求结构
{
"pageNo": 1,
"pageSize": 10,
"action": "",
"switch": 1,
"subdomain": ["example.com"],
"ruleID": "",
"ruleName": ""
}示例代码
curl -X POST "/v1/waf/customRules/list" \
-H "Content-Type: application/json" \
-d '{
"pageNo": 1,
"pageSize": 10
}'{
"pageNo": 1,
"pageSize": 10
}返回响应
Headers 参数
除公共头域外，无其它特殊头域
返回参数
success
boolean
必选
status
integer
必选
result
object {2}
必选
显示子属性
隐藏子属性
result
array
必选
显示子属性
隐藏子属性
items
object {10}
显示子属性
隐藏子属性
ruleName
string
规则名称
必选
ruleType
string
接入类型。saas / native
必选
protectionDomains
array
防护站点
必选
显示子属性
隐藏子属性
items
string
action
string
处置动作
必选
switch
integer
开关状态。0 => 关、1=>开
必选
effectiveType
integer
生效模式。可选值: 0, 1, 2
可选
effectiveTime
object {3}
生效时段
可选
显示子属性
隐藏子属性
range
array
指定生效时间段
可选
显示子属性
隐藏子属性
items
object {2}
显示子属性
隐藏子属性
start
string
格式: date-time
必选
end
string
格式: date-time
必选
schedule
array
指定生效周期
必选
显示子属性
隐藏子属性
items
object {2}
显示子属性
隐藏子属性
days_of_week
array
星期类型
必选
显示子属性
隐藏子属性
items
integer
可选值: 0, 1, 2, 3, 4, 5, 6
range
object {2}
必选
显示子属性
隐藏子属性
start
string
格式: date-time
必选
end
string
格式: date-time
必选
time_zone
integer
时区
必选
updateTime
string
更新时间
必选
ruleKey
string
规则唯一标识
必选
ruleID
integer
全局规则ID
必选
totalCount
integer
总数
必选
成功响应
{
"success": true,
"status": 200,
"result": {
"result": [
{
"ruleName": "test_rule",
"ruleType": "saas",
"protectionDomains": ["example.com"],
"action": "block",
"switch": 1,
"effectiveType": 0,
"effectiveTime": {
"schedule": [],
"time_zone": 8
},
"updateTime": "2023-01-01 12:00:00",
"ruleKey": "key_123",
"ruleID": 1001
}
],
"totalCount": 1
}
}