跳转至

查询自定义控制规则

1. 接口描述

接口请求路径：GET /prod-api/waf/wafv3/custom/rules/describeCustomRule/{customRuleId}

describeCustomRule 用于按规则 ID 查询单条自定义控制规则的完整配置（匹配条件与处置动作），供编辑页回显。规则 ID 来自 列出自定义控制规则。ruleClass 为 default 的定制规则不可查询。

Token 获取方式见 密钥鉴权。

2. 输入参数

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

参数名称 必选 类型 描述
customRuleId 是 Long 自定义规则 ID（Path）
示例值：61

3. 示例

示例1 查询单条规则详情

输入示例

GET /prod-api/waf/wafv3/custom/rules/describeCustomRule/61

代码调用

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

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class DescribeCustomRuleTest {

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

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpGet httpGet = new HttpGet(url);
            httpGet.setHeader("Authorization", "Bearer " + token);

            try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
                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 (
    "fmt"
    "io"
    "net/http"
)

func main() {
    url := "https://{登录域名}/prod-api/waf/wafv3/custom/rules/describeCustomRule/61"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    req, err := http.NewRequest(http.MethodGet, url, nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)

    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": {
    "customRuleId": 61,
    "wafId": null,
    "ruleMessage": "sql注入攻击 包含",
    "sort": 1,
    "rules": {
      "action": {
        "action": "DENY",
        "parameters": [
          {
            "name": "log",
            "values": ["log"]
          }
        ]
      },
      "conditions": [
        [
          {
            "conditionId": 120000456,
            "operator": "INT_EQ",
            "target": "CHECK_REQUEST_HEADERS_NAMES",
            "name": "APP",
            "values": ["0"]
          },
          {
            "conditionId": 120000457,
            "operator": "IP_IN_LIST",
            "target": "IP_SRC",
            "name": "IP_SRC",
            "values": ["52"]
          }
        ]
      ]
    },
    "status": "enable"
  }
}

4. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值：200
msg String 提示信息。示例值：成功
data Object 规则详情，结构同 编辑自定义控制规则 请求体
data.customRuleId Long 规则 ID。示例值：61
data.wafId Long 策略组 ID；详情接口可能为 null
data.ruleMessage String 规则名称
data.sort Integer 排序权重
data.status String 启用状态，支持以下值：
enable：启用
disable：关闭
data.rules Object 规则内容，见 CustomRuleVO

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
规则不存在 规则不属于当前用户或不存在
失败，定制规则无法查询 ruleClass 为 default
查询失败，无效的customRuleId 规则 ID 无效
查询失败，未获取到执行动作，请联系管理员 动作数据缺失