You need to enable JavaScript to run this app.
导航
Web应用防火墙
  • 文档首页
    • /
  • Web应用防火墙

ListAllowRule-查询访问白名单规则详情

最近更新时间：2024.03.01 16:47:39

首次发布时间：2024.02.01 14:25:22

我的收藏

查询指定域名下的访问白名单规则详情。

请求说明

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

请求参数

参数

类型

是否必填

示例值

描述

Page

Integer

否

1

查询页码，默认为 1。

PageSize

Integer

否

20

单页条数，默认为 10。范围为 1～100。

Host

String

是

example.volcwaf001.com

需要查询的规则所属域名。

返回参数

参数

类型

示例值

描述

TotalCount

Integer

15

查询到的符合条件的条目总数。

PageSize

Integer

20

单个页面显示的条目数量上限。

CurrentPage

Integer

1

当前页面的页码。

Count

Integer

10

当前页面显示的条目数量。

Data

Array of Data objects

-

规则详情。

Data

参数

类型

示例值

描述

Id

Integer

1234

规则 ID 标识符。用于查询、修改和删除对应规则。

IpAddType

Integer

1

地址组添加方式。

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

IpGroups

Array of IpGroups objects

-

IP 地址组信息。当IpAddType=2 时展示。

Name

String

testwaf

规则名称。

IsolationId

String

cn-beijing

规则对应的域名所属地域。

ClientIp

String

1.1.1.1

IP 地址信息。

  • 如为单个 IP 地址或 IP 地址段，则展示具体地址。
  • 如为 IP 地址组，则展示IPGROUP。

Url

String

/test

匹配路径。

Enable

Integer

1

规则开关。

  • 0：关闭
  • 1：开启

GroupId

Integer

12345

规则组 ID。

Advanced

Integer

1

是否配置高级条件。

  • 0：否
  • 1：是

Accurate

Accurate object

-

Advanced=1时展示。

Description

String

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

规则备注。

RuleTag

String

A000000005604

规则 ID 全称。

UpdateTime

String

2024-01-05T18:55:54+08:00

规则更新时间。

IsolationId

String

cn-shanghai

规则所属域名的地域信息。

IpGroups

参数

类型

示例值

描述

IpGroupId

Integer

4063

地址组 ID。

Name

String

地址组1

地址组名称。

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

12345

高级条件 ID。

请求示例

POST https://open.volcengineapi.com/?Action=ListAllowRule&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"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240201164928A34EBA9C1D0B9217****",
        "Action": "ListAllowRule",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {  
            "TotalCount": 1,
            "PageSize": 10,
            "CurrentPage": 1,
            "Count": 1,
            "Data": [
            {
                "Accurate": {
                    "AccurateRules": [
                        {
                            "HttpObj": "request.uri",
                            "Id": 54321,
                            "ObjType": 1,
                            "Opretar": 5,
                            "Property": 0,
                            "ValueString": "0"
                        }
                    ],
                    "Logic": 2
                },
                "Advanced": 1,
                "ClientIp": "IPGROUP",
                "Description": "",
                "Enable": 0,
                "GroupId": 57082,
                "Host": "*.test.com",
                "Id": 13253,
                "IpAddType": 2,
                "IpGroups": [
                    {
                        "IpGroupId": 4063,
                        "Name": "test233"
                    }
                ],
                "IsolationId": "cn-beijing",
                "Name": "23",
                "RuleTag": "A000000013253",
                "UpdateTime": "2024-01-31T15:42:07+08:00",
                "Url": "/cc.txt"
            }
        ]
    }
}