创建自定义控制规则¶

1. 接口描述¶

接口请求路径：POST /prod-api/waf/nlaV1/custom/rules/modifyCustomRule

modifyCustomRule 同时用于创建与编辑。创建时省略 customRuleId（或不传 / 为 null），服务端将新增规则并返回新规则 ID。编辑场景见编辑自定义控制规则。

Token 获取方式见密钥鉴权。

2. 输入参数¶

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

参数名称	必选	类型	描述
aclId	是	Long	所属策略组 ID。示例值：`74`
ruleMessage	是	String	规则名称，最长 30 字符；不可含 `\`、`'`、`"`。示例值：`deemo`
status	是	String	启用状态。取值：`enable`（启用）、`disable`（关闭）。示例值：`enable`
rules	是	NlaCustomRule	规则内容
customRuleId	否	Long	创建时省略或为 `null`；传入已有 ID 则为编辑
sort	否	Integer	排序权重

3. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`成功`
data	Long	新建规则的 `customRuleId`。示例值：`128`

4. 示例¶

示例1 创建拦截规则¶

输入示例¶

{
  "ruleMessage": "deemo",
  "status": "enable",
  "aclId": 74,
  "rules": {
    "conditions": [
      [
        {
          "target": "HOST",
          "operator": "EQ",
          "values": ["test.ruisuyun.com"],
          "name": "HOST"
        }
      ]
    ],
    "action": {
      "action": "DENY",
      "parameters": [
        { "name": "log", "values": ["log"] },
        { "name": "statusCode", "values": ["418"] }
      ]
    }
  }
}

代码调用¶

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

cURLJavaGo

curl -X POST 'https://{登录域名}/prod-api/waf/nlaV1/custom/rules/modifyCustomRule' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "ruleMessage": "deemo",
  "status": "enable",
  "aclId": 74,
  "rules": {
    "conditions": [[{
      "target": "HOST",
      "operator": "EQ",
      "values": ["test.ruisuyun.com"],
      "name": "HOST"
    }]],
    "action": {
      "action": "DENY",
      "parameters": [
        {"name": "log", "values": ["log"]},
        {"name": "statusCode", "values": ["418"]}
      ]
    }
  }
}'

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 CreatCustomRuleTest {

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

        String requestBody = "{"
                + "\"ruleMessage\":\"deemo\","
                + "\"status\":\"enable\","
                + "\"aclId\":74,"
                + "\"rules\":{"
                + "\"conditions\":[[{"
                + "\"target\":\"HOST\",\"operator\":\"EQ\","
                + "\"values\":[\"test.ruisuyun.com\"],\"name\":\"HOST\""
                + "}]],"
                + "\"action\":{"
                + "\"action\":\"DENY\","
                + "\"parameters\":["
                + "{\"name\":\"log\",\"values\":[\"log\"]},"
                + "{\"name\":\"statusCode\",\"values\":[\"418\"]}"
                + "]"
                + "}"
                + "}"
                + "}";

        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/nlaV1/custom/rules/modifyCustomRule"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "ruleMessage": "deemo",
  "status": "enable",
  "aclId": 74,
  "rules": {
    "conditions": [[{
      "target": "HOST",
      "operator": "EQ",
      "values": ["test.ruisuyun.com"],
      "name": "HOST"
    }]],
    "action": {
      "action": "DENY",
      "parameters": [
        {"name": "log", "values": ["log"]},
        {"name": "statusCode", "values": ["418"]}
      ]
    }
  }
}`)

    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": 128
}

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
规则描述不能为空	Controller 校验：`ruleMessage` 为空
规则名称[ruleName]不能为空	校验注解：`ruleMessage` 为空
执行动作不能为空	`rules.action` 为空
规则描述中不能包含特殊字符	`ruleMessage` 含 `\`、`'` 或 `"`
状态[status]只能为disable或enable	`status` 取值非法
规则状态[status]不能为空	未传 `status`
[nlaId]不能为空	未传 `aclId`
规则名称[ruleMessage]不能超过30位	名称超长
请输入至少一个条件	`conditions` 为空
只能输入一个条件集合	`conditions` 外层数组超过 1 组
无效的target	条件 `target` 非法
值不能为空	条件 `values` 为空
更新失败，请确认提交信息是否正确	提交数据校验失败

6. 数据模型¶

NlaCustomRule¶

自定义规则的匹配条件与命中动作。

参数名称	必选	类型	描述
action	是	NlaCustomRuleAction	命中后动作
conditions	是	[NlaCustomRuleCondition]	条件组二维数组；组内为与关系。当前仅支持一组

NlaCustomRuleCondition¶

单条匹配条件。

参数名称	必选	类型	描述
target	是	String	匹配维度，与查询条件参数一致。示例值：`HOST`
operator	是	String	运算符，如 `EQ`、`ENDS_WITH`。示例值：`EQ`
name	否	String	维度名，常与 `target` 相同。示例值：`HOST`
values	是	Array of String	比较取值。示例值：`["test.ruisuyun.com"]`
conditionId	否	Long	新建时可省略

NlaCustomRuleAction¶

命中后执行动作。

参数名称	必选	类型	描述
action	是	String	动作编码。取值：`DENY`（拦截）、`LOG`（仅记录）、`ALLOW`（跳过后续规则）、`LIMIT_RATE`（频率限速）、`CAPTCHA`（人机验证）、`DETECTION_ROBOT`（验证爬虫）、`REDIRECT`（重定向）、`AUTHENTICATION`（鉴权）。示例值：`DENY`
parameters	否	[NlaCustomRuleActionParameters]	动作参数

NlaCustomRuleActionParameters¶

动作参数项。

参数名称	必选	类型	描述
name	是	String	参数键。常见：`log`、`statusCode`、`url`、`traits`、`limit_access`、`limit_time`、`behavior`、`limit_blacklist`、`validType`、`signatureParameterName`、`validTime`、`authKey`
values	是	Array of String	参数值列表

常用动作参数示例：

DENY：log + statusCode（如 418）
LOG / ALLOW / CAPTCHA / DETECTION_ROBOT：通常仅 log（log / nolog）
REDIRECT：log + url + statusCode（301 / 302 等）
LIMIT_RATE：log、traits（JSON 字符串）、limit_access、limit_time、behavior（excess / all）、limit_blacklist
AUTHENTICATION：log、validType、signatureParameterName、validTime、authKey