WAF3.0 API¶
POST 列出域名的防篡改规则¶
POST /prod-api/waf/wafv3/falsify/describeFalsifyByDomain
分页查询指定域名下已配置的 防篡改路径规则(受保护页面全路径)。domainId 来自 列出防篡改域名 中点击域名进入规则抽屉时的 rows[].domainId。
- 新增/编辑规则: 更新防篡改规则(新建不传
falsifyRuleId,编辑传falsifyRuleId= 本接口locationId) - 删除规则: 删除防篡改规则(
falsifyRuleId=locationId) - 刷新页面缓存: 刷新防篡改规则缓存(
falsifyRuleId=locationId) - 域名级总开关: 开启关闭防篡改
Body 请求参数
Body 字段说明¶
| 字段 | 类型 | 必选 | 说明 |
|---|---|---|---|
domainId |
integer(int64) | 是 | 域名 ID,与 列出防篡改域名 的 rows[].domainId 一致 |
pageNum |
integer | 是 | 页码,从 1 开始 |
pageSize |
integer | 是 | 每页条数 |
服务端查询时固定
source = falsify,无需在请求体中传source。
请求参数¶
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Authorization | header | string | 是 | 鉴权 | Bearer Token |
| body | body | object | 是 | 请求体 | 见上文 |
返回示例
200 Response
{
"total": 1,
"rows": [
{
"locationId": 2680,
"name": "/root/index.jsp",
"type": "4",
"json": null,
"sort": 999
}
],
"code": 200,
"msg": "成功"
}
返回结果¶
| 状态码 | 状态码含义 | 说明 |
|---|---|---|
| 200 | OK | 成功 |
| 401 | Unauthorized | 未授权 |
| 403 | Forbidden | 无权限 |
返回数据结构¶
状态码 200(分页结构 TableDataInfo)
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
code |
integer | 是 | 状态码 | 200 表示成功 |
msg |
string | 是 | 提示信息 | - |
total |
integer | 是 | 总记录数 | 该域名下防篡改规则总数 |
rows |
array | 是 | 规则列表 | 见下表 |
rows[] 单条规则¶
| 字段 | 类型 | 说明 |
|---|---|---|
locationId |
integer(int64) | 规则/路径 ID;编辑、删除、刷新缓存时作为 falsifyRuleId 传入 |
name |
string | 受保护页面全路径(如 /root/index.jsp),需以 / 开头;首次访问时 WAF 缓存该路径页面 |
type |
string | 规则类型,防篡改固定为 "4" |
json |
string / null | 扩展配置;防篡改规则一般为 null |
sort |
integer | 排序权重; |