WAF3.0 API¶

POST 列出额外插件库¶

POST /prod-api/waf/wafv3/plugin/library/describePluginLibrary

分页查询指定 策略组（wafId） 可用的 额外插件（规则排除集、反机器人等）。通过 searchHeader.recommendSite 按推荐站点类型筛选；批量启用/关闭见更新额外插件状态。

Body 请求参数

不筛选（列出全部，或控制台默认视图）：

{
  "pageNum": 1,
  "pageSize": 50,
  "wafId": 22,
  "searchHeader": {},
  "params": {}
}

按推荐站点类型筛选（常用）：

{
  "pageNum": 1,
  "pageSize": 50,
  "wafId": 22,
  "searchHeader": {
    "recommendSite": "common"
  },
  "params": {}
}

Body 字段说明¶

字段	类型	必选	说明
`wafId`	integer(int64)	是	策略组 ID
`pageNum`	integer	是	页码，从 `1` 开始
`pageSize`	integer	是	每页条数
`searchHeader`	object	是	筛选条件；不筛选时传 `{}`，按站点类型筛选时传 `recommendSite`
`params`	object	否	扩展参数，一般传 `{}`

userId 由服务端根据登录态自动填充，无需传递。

`searchHeader`（按推荐站点筛选）¶

字段	类型	必选	说明
`recommendSite`	string	否	站点类型编码；只返回 `recommendSite` 字段中包含该类型的插件

示例：

`searchHeader`	含义
`{}`	不按站点筛选，返回全部插件
`{ "recommendSite": "common" }`	仅返回推荐站点含「通用」的插件
`{ "recommendSite": "blog" }`	仅返回推荐站点含「博客」的插件

recommendSite 可选取值（与控制台字典 waf_recommend_site_type 一致）：

取值	含义（示例）
`common`	通用
`portal_website`	门户/官网
`forum_community`	论坛/社区
`blog`	博客
`mall`	商城

返回中每条插件的 recommendSite 可能为多个类型逗号拼接（如 common,blog,mall），只要其中包含请求的 recommendSite 即会出现在列表中。

请求参数¶

名称	位置	类型	必选	中文名	说明
Authorization	header	string	是	鉴权	Bearer Token
body	body	object	是	请求体	见上文

返回示例

200 Response

{
  "total": 10,
  "rows": [
    {
      "status": "ON",
      "pluginCode": "fake-bot",
      "pluginName": "过滤伪造机器人",
      "pluginMessage": "旨在拦截伪造知名用户代理（User-Agent）进行HTTP请求的机器人和冒充者……",
      "recommendSite": "common,portal_website,forum_community,blog,mall"
    },
    {
      "status": "OFF",
      "pluginCode": "wordpress-rule-exclusions",
      "pluginName": "WordPress 规则排除",
      "pluginMessage": "针对 WordPress CMS 的规则排除项，可与 OWASP CRS 协同运行……",
      "recommendSite": "common,portal_website,forum_community,blog,mall"
    }
  ],
  "code": 200,
  "msg": "成功"
}

返回结果¶

状态码	状态码含义	说明
200	OK	成功
401	Unauthorized	未授权
403	Forbidden	无权限

返回数据结构¶

状态码 200

名称	类型	说明
`total`	integer	符合条件的插件总条数
`rows`	[object]	当前页插件列表
`code`	integer	`200` 表示成功
`msg`	string	提示信息

`rows[]` 每条插件¶

字段	类型	说明
`status`	string	当前 `wafId` 下：`ON` 已启用，`OFF` 未启用
`pluginCode`	string	插件编码；更新额外插件状态的 `pluginCodes` 使用此值
`pluginName`	string	插件名称
`pluginMessage`	string	功能说明
`recommendSite`	string	推荐的站点类型，多个用英文逗号分隔

`status` 取值¶

值	含义
`ON`	已启用
`OFF`	未启用

与 `changePluginStatus` 的配合¶

按需带 searchHeader.recommendSite 调用本接口获取 rows。
POST changePluginStatus 批量开关：

{
  "wafId": 22,
  "pluginCodes": ["fake-bot", "wordpress-rule-exclusions"],
  "status": "ON"
}