更新额外插件状态

1. 接口描述

接口请求路径：POST /prod-api/waf/wafv3/plugin/library/changePluginStatus

changePluginStatus 用于批量启用或关闭指定策略组下的额外插件。pluginCodes 来自 查询额外插件库列表 返回的 pluginCode。

Token 获取方式见 密钥鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称	必选	类型	描述
wafId	是	Long	策略组 ID 示例值：22
pluginCodes	是	Array of String	要更新的插件编码列表 示例值：["fake-bot","wordpress-rule-exclusions"]
status	是	String	目标状态，支持以下值： ON：启用 OFF：关闭 示例值：ON

3. 示例

示例1 批量启用额外插件

输入示例

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

代码调用

请将 {登录域名}、token 替换为实际值。

JavaGo

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class ChangePluginStatusTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/waf/wafv3/plugin/library/changePluginStatus";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        String requestBody = "{"
                + "\"wafId\":22,"
                + "\"pluginCodes\":[\"fake-bot\",\"wordpress-rule-exclusions\"],"
                + "\"status\":\"ON\""
                + "}";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("Authorization", "Bearer " + token);
            httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));

            try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
                int statusCode = response.getStatusLine().getStatusCode();
                String body = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("Status Code: " + statusCode);
                System.out.println("Body: " + body);
            }
        }
    }
}

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    url := "https://{登录域名}/prod-api/waf/wafv3/plugin/library/changePluginStatus"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "wafId": 22,
  "pluginCodes": ["fake-bot", "wordpress-rule-exclusions"],
  "status": "ON"
}`)

    req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println("Status Code:", resp.StatusCode)
    fmt.Println("Body:", string(body))
}

输出示例

全部成功时：

{
  "msg": "成功",
  "code": 200,
  "data": []
}

部分插件不存在时：

{
  "msg": "成功",
  "code": 200,
  "data": [
    {
      "pluginCode": "unknown-plugin",
      "message": "插件不存在"
    }
  ]
}

4. 输出参数

参数名称	类型	描述
code	Integer	状态码。示例值：200
msg	String	提示信息。示例值：成功
data	Array	失败项列表；全部成功时为空数组
data[].pluginCode	String	失败的插件编码。示例值：unknown-plugin
data[].message	String	失败原因。示例值：插件不存在

5. 错误码

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
查询失败，无效的wafId	wafId 不存在或不属于当前账号
wafId不能为空	未传 wafId
pluginCode不能为空	未传 pluginCodes
status不能为空	未传 status
状态[status]只能为OFF、ON	status 取值非法