跳转至

创建策略组

1. 接口描述

接口请求路径:POST /prod-api/waf/wafv3/acl/createWebACL

createWebACL 用于在指定套餐下创建 Web 应用防火墙(WAF 3.0)策略组,并可关联域名。

Token 获取方式见 密钥鉴权

2. 输入参数

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

参数名称 必选 类型 描述
aclName String 策略组名称
示例值:测试
oid String 所属套餐号
示例值:2024012345679097884616
aclStatus String 策略组状态,支持以下值:
On:启用
Off:关闭
DetectionOnly:仅记录
示例值:DetectionOnly
paranoiaLevel String 防护等级,支持以下值:
lenient:宽松模式
balanced:平衡模式
strict:严格模式
示例值:lenient
domainIds Array of Long 关联域名 ID 列表;可为空
示例值:[215, 219]
remark String 备注
示例值:``

3. 示例

示例1 创建策略组

输入示例

{
  "aclName": "测试",
  "domainIds": [215, 219],
  "aclStatus": "DetectionOnly",
  "paranoiaLevel": "lenient",
  "oid": "2024012345679097884616"
}

代码调用

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

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

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

        String requestBody = "{"
                + "\"aclName\":\"测试\","
                + "\"domainIds\":[215,219],"
                + "\"aclStatus\":\"DetectionOnly\","
                + "\"paranoiaLevel\":\"lenient\","
                + "\"oid\":\"2024012345679097884616\""
                + "}";

        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/acl/createWebACL"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "aclName": "测试",
  "domainIds": [215, 219],
  "aclStatus": "DetectionOnly",
  "paranoiaLevel": "lenient",
  "oid": "2024012345679097884616"
}`)

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

4. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:成功
data Long 新建策略组 ID。示例值:150

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
名称不能为空 未传 aclName
所属套餐不能为空 未传 oid
状态[aclStatus]只能为On|Off|DetectionOnly aclStatus 取值非法
WAF防护模式类型无效 paranoiaLevel 取值非法
创建失败,可能原因:1.套餐{oid}状态不可用;2.套餐ID错误 套餐不可用或 OID 错误
创建失败,可能原因:1.存在错误的域名ID;2.域名不在套餐[{oid}]下 关联域名校验失败