You need to enable JavaScript to run this app.
导航
CreateAllowRule-创建访问白名单规则
最近更新时间:2024.03.01 16:47:39首次发布时间:2024.02.01 14:25:22

创建访问白名单规则,将特定 IP 添加到访问白名单中,该 IP 下的指定访问行为将不受所有检测拦截规则的影响,直接被放行。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=CreateAllowRule&Version=2023-12-25

请求参数

参数

类型

是否必填

示例值

描述

Host

String

example.volcwaf001.com

需要添加防护规则的域名。

IpAddType

Integer

1

地址添加方式。

  • 1:手动添加
  • 2:引用地址组

Name

String

testwaf

规则名称,支持英文、汉字、数字,不支持特殊字符,长度限制在 25 个字符内。

ClientIp

String

1.1.1.1

需要加入白名单的 IP 地址。

  • 地址添加方式为手动添加,即IpAddType=1 时需要填写。
  • 支持单个 IP 地址和 IP 地址段,IP 地址段支持 16-32。

IpGroupId

Integer

1378

需要引用的地址组 ID。
地址添加方式为引用地址组,即IpAddType=2时需要填写。地址组 ID 获取方式,可参考ListAllIpGroups-查询所有地址组

Url

String

/test

匹配路径。支持通配符**只能出现一次。

  • 某个具体的 URL 地址,例如需要放行test.com/test.html,则填写 /test.html
  • 针对整个网站,则填写/即可。
  • 某个路径前缀适配的所有地址,例如/test/*

Enable

Integer

1

规则开关。默认为开启。

  • 0:关闭
  • 1:开启

Advanced

Integer

1

是否配置高级条件。

  • 0:否
  • 1:是

Accurate

Accurate object

-

Advanced=1时需要填写。

Description

String

增加一条白名单规则,用于放行特定 IP。

规则备注。

Accurate

参数

类型

是否必填

示例值

描述

AccurateRules

Array of AccurateRules objects

-

规则详情。

Logic

Integer

1

高级条件的逻辑关系。

  • 1:与
  • 2:或

AccurateRules

参数

类型

是否必填

示例值

描述

HttpObj

String

request.method

自定义对象,与ObjType存在映射关系。

  • 请求协议:request.schema
  • 请求 uri:request.uri
  • 请求方法:request.method
  • 请求路径:request.path
  • 请求参数:request.queryargs
  • 请求头:request.header
  • 请求 User-Agent:request.header.ua
  • 请求 refer:request.header.refer
  • 请求 Cookies:request.header.cookies
  • 请求体长度:request.header.content-length
  • 请求体格式:request.header.content-type
  • X-forwarded-for:request.header.x-forwarded-for
  • 客户端 IP:request.header.clientip
  • 自定义 Args:request.queryargs.自定义参数名称。例如request.queryargs.abc
  • 自定义 header:request.header.自定义Header 名称。例如request.header.abc
  • 自定义 cookie:request.cookie.自定义 cookie 名称。例如request.cookie.abc

ObjType

Integer

0

匹配字段。

  • 0:请求协议
  • 1:请求 uri
  • 2:请求方法
  • 3:请求路径
  • 4:请求参数
  • 5:请求头
  • 6:请求 User-Agent
  • 7:请求 refer
  • 8:请求 Cookies
  • 9:请求体长度
  • 10:请求体格式
  • 11:X-forwarded-for
  • 12:客户端 IP
  • 13:自定义 Args
  • 14:自定义 header
  • 15:自定义 cookie

Opretar

Integer

0

逻辑运算符。

  • 0:大于
  • 1:大于等于
  • 2:等于
  • 3:小于
  • 4:小于等于
  • 5:不等于
  • 6:包含子串
  • 7:不包含子串
  • 8:包含前缀
  • 9:不包含前缀
  • 10:包含后缀
  • 11:不包含后缀
  • 12:包含所有匹配集合
  • 13:不包含所有匹配集合
  • 14:属于匹配集合
  • 15:不属于匹配集合
  • 16:正则
  • 17:判断为 IP
  • 18:判断为 IPv4
  • 19:判断为 IPv6
  • 20:判断为私网 IP
  • 21:判断为公网 IP

Property

Integer

0

固定取值为 0,取HttpObj的值用于匹配对应详情。

ValueString

String

123

匹配内容。
逻辑关系判断为 IP、 IPv4、 IPv6、私网 IP 或公网 IP 时不需要填写。

返回参数

参数

类型

示例值

描述

Id

Integer

9999

创建的规则 ID。

请求示例

POST https://open.volcengineapi.com/?Action=CreateAllowRule&Version=2023-12-25
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

{
    "Host":"example.volcwaf001.com",
    "IpAddType":1,
    "Name":"testwaf",
    "ClientIp":"1.1.1.1",
    "Url":"/test",
    "Enable":1,
    "Advanced":1,
    "Accurate":{
        "Logic":1,
        "AccurateRules":[
            {
                "Property":0,
                "HttpObj":"request.schema",
                "ObjType":0,
                "Opretar":2,
                "ValueString":"Get"
            }
        ]
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210816110638947C2514606306AF****",
        "Action": "CreateAllowRule",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    }, 
    "Result": {
        "Id": 9999
    }
}