更新 CRS 设置规则¶

1. 接口描述¶

接口请求路径：POST /prod-api/waf/wafv3/custody/rules/modifyCrsSetupRule

modifyCrsSetupRule 用于更新指定策略组下某条 CRS 设置规则的 variable 配置，不改变规则本身的启用状态。规则定义与可选值范围请先通过查询 CRS 设置规则列表获取。

Token 获取方式见密钥鉴权。

2. 输入参数¶

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

参数名称	必选	类型	描述
wafId	是	Long	策略组 ID 示例值：`22`
ruleId	是	Long	CRS 设置规则 ID，取自列表接口 `rows[].ruleId` 示例值：`900200`
variable	是	Array	变量配置列表，至少一项
variable[].name	是	String	变量名，须与 `variableModel[].name` 一致示例值：`tx.allowed_methods`
variable[].values	是	Array of String	新取值。`arrayOfString` 为多值；`integer` 仅 1 个数字字符串示例值：`["GET","HEAD","POST","OPTIONS","PUT"]`

3. 示例¶

示例1 调整允许的 HTTP 方法¶

输入示例¶

{
  "wafId": 22,
  "ruleId": 900200,
  "variable": [
    {
      "name": "tx.allowed_methods",
      "values": ["GET", "HEAD", "POST", "OPTIONS", "PUT", "PATCH", "DELETE"]
    }
  ]
}

代码调用¶

请将 {登录域名}、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 ModifyCrsSetupRuleTest {

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

        String requestBody = "{"
                + "\"wafId\":22,"
                + "\"ruleId\":900200,"
                + "\"variable\":[{"
                + "\"name\":\"tx.allowed_methods\","
                + "\"values\":[\"GET\",\"HEAD\",\"POST\",\"OPTIONS\",\"PUT\",\"PATCH\",\"DELETE\"]"
                + "}]"
                + "}";

        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/custody/rules/modifyCrsSetupRule"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "wafId": 22,
  "ruleId": 900200,
  "variable": [
    {
      "name": "tx.allowed_methods",
      "values": ["GET", "HEAD", "POST", "OPTIONS", "PUT", "PATCH", "DELETE"]
    }
  ]
}`)

    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
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`操作成功`

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
查询失败，无效的wafId	`wafId` 不存在或不属于当前账号
无效的规则id:{ruleId}	`ruleId` 不存在
无效的变量名:{name}	`variable[].name` 不在该规则的 `variableModel` 中
变量{name}的值不能为空	`variable[].values` 为空
无效的参数值:{value}	`arrayOfString` 类型取值不在可选列表内
值必须为整数	`integer` 类型取值非法
值必须在{min}-{max}之间	`integer` 类型超出可选范围