文档中心

云原生Web应用防火墙 CWAF API参考手册

最近更新时间：2023-04-16 17:00:00

1 网站设置

1.1 AddBlackWhiteList

防护设置增加黑白名单配置。增加配置后，需要调用“SyncPolicy”同步配置接口，配置才会生效。

1.1.1 使用说明

路径(POST): https://{endpoint}/cwaf/v1.0/access

1.1.2 请求参数

表1-1 body 中请求参数

表1-2 RuleList 字段说明

表1-3 FieldType 字典说明

表1-4 Rule 字典说明

1.1.3 返回数据

1.1.4 示例

1. 请求实例
POST：https://{endpoint}/cwaf/v1.0/access
    {
        "DomainId": 5,
        "Name": "test83",
        "Type": 1,
        "RuleList": [
    {
         "FieldType": 8,
         "FieldKey": "",
         "Rule": 5,
         "Content": "GET"
     },
      {
         "FieldType": 8,
         "FieldKey": "",
         "Rule": 6,
         "Content": "POST"
         }
     ]
}
2. 正常返回实示例
HTTP/1.1 200 OK
Content-Type: application/json
{
     "RequestId": "61901dcc-0216-48c7-a224-d06f3b6ef552"
}

1.2 DeleteBlackWhiteList

防护设置删除黑白名单配置。删除配置后，需要调用“SyncPolicy”同步配置接口，配置才会生效。

1.2.1 使用说明

路径（DELETE）：https://{endpoint}/cwaf/v1.0/access/{Id}

1.2.2 请求参数

1.2.3 返回数据

1.2.4 示例

1. 请求示例
DELETE：https://{endpoint}/cwaf/v1.0/access/8
2. 正常返回实示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"RequestId": "11cbfca6-26bd-4bc9-8d14-4d565d062459"
}

1.3 GetBlackWhiteList

获取黑白名单配置列表。

1.3.1 使用说明

路径（GET）：https://{endpoint}/cwaf/v1.0/access

1.3.2 请求参数

1.3.3 返回数据

表1-5 AccessList 字段说明

1.3.4 示例

1. 请求示例
GET：https://{endpoint}/cwaf/v1.0/access?DomainId=8&Type=1
2. 正常返回实示例
HTTP/1.1 200 OK
Content-Type: application/json
{
     "AccessList": [
    {
         "Id": 3,
         "DomainId": 2,
         "Name": "testlc",
         "Type": 1,
         "CloudLoginId": "220008093000300",
         "RuleList": null,
         "FieldTypes": "IP",
         "CreateTime": "2022-09-15 22:32:47",
         "UpdateTime": "2022-09-15 22:32:47"
    }
    ],
     "RequestId": "cea62e59-aea9-4415-b67f-9ec8073fd5e2",
     "TotalCount": 1,
     "PageSize": 10,
     "PageNumber": 1
}

1.4 SyncPolicy

同步黑白名单策略。

1.4.1 使用说明

路径（PUT）：https://{endpoint}/cwaf/v1.0/domainConfig/sync/{DomainId}

1.4.2 请求参数

1.4.3 返回数据

1.4.4 示例

1. 请求示例
PUT：https://{endpoint}/cwaf/v1.0/domainConfig/sync/8
2. 正常返回实示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"RequestId": "caf149dc-d934-4737-a548-87695ae3f623"
}

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服