文档中心

Web应用防火墙

访问管控

ListCustomPage - 查询自定义拦截响应规则

调用 ListCustomPage 接口查询指定域名下自定义响应拦截规则详情。

请求说明

请求方式：POST

请求地址：https://waf.volcengineapi.com/?Action=ListCustomPage&Version=2023-12-25

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action String 必选示例值：ListCustomPage

接口名称。当前 API 的名称为 ListCustomPage。

Version String 必选示例值：2023-12-25

接口版本。当前 API 的版本为 2023-12-25。

Body

Page Integer 可选示例值：1

查询页码，默认为 1。

RuleTag String 可选示例值：D000000001642

规则标识，精确匹配搜索。

Host String 必选示例值：example.com

需要查看的域名。

ProjectName String 可选示例值：default

所属项目资源名称，获取方式可参考ListProjectResources - 获取项目资源列表。

PageSize Integer 可选示例值：10

单个页面显示的条目数量上限。默认为 10。范围为 1～100。

返回参数

PageNumber Integer 可选示例值：10

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

CurrentPage Integer 可选示例值：1

当前页面的页码。

PageSize Integer 可选示例值：10

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

Data Object[] 可选示例值：--

规则详情。

Advanced Integer 可选示例值：1

是否配置高级条件。

0：否

1：是

Body String 可选示例值：<!DOCTYPE html> <html> <meta charset="utf-8"> <body> <p> !!! 系统禁止访问 </p> </body> </html>

页面内容。

当PageMode=0时，需要传入的内容为固定模板。

text/html：<!DOCTYPE html> <html> <meta charset="utf-8"> <body> <p> !!! 系统禁止访问 </p> </body> </html>

text/xml：<?xml version="1.0" encoding="UTF-8"?><body> !!! 系统禁止访问 </body>

application/json：{"Content":"!!! 系统禁止访问"}

当PageMode=1时，支持自定义内容。

ClientIp String 可选示例值：ALL

生效 IP 范围，需填写 ALL，即对所有 IP 生效。

Code String 可选示例值：403

自定义 HTTP 返回码。

ContentType String 可选示例值：text/html

页面类型。

text/html

text/xml

application/json

Description String 可选示例值：增加一条自定义响应拦截规则。

规则备注。

Enable Integer 可选示例值：1

规则开关，默认为开启。

0：关闭

1：开启

GroupId Integer 可选示例值：9923

高级条件规则组 ID，获取方式可参考ListCustomPage-查询自定义响应拦截规则详情。

Header String 可选示例值：Header

请求头信息。

Host String 可选示例值：example.com

防护规则关联的域名。

Id Integer 可选示例值：1876

规则 ID。

IsolationId String 可选示例值：cn-beijing

地域 ID。

Name String 可选示例值：自定义规则1

规则名称。

PageMode Integer 可选示例值：0

响应页面模板。

0：系统默认

1：自定义

2：重定向

Policy Integer 可选示例值：1

策略执行动作：

1 : 观察

8：拦截

RedirectUrl String 可选示例值：RedirectUrl

重定向匹配路径，PageMode=2时需要填写。

RuleTag String 可选示例值：D000000000961

规则唯一标识。

UpdateTime String 可选示例值：2024-01-24T17:08:29+08:00

规则更新时间。

Url String 可选示例值：/test/*

防护规则的匹配路径。

Accurate Object 可选示例值：--

高级条件详情。

Logic Integer 可选示例值：1

高级条件的逻辑关系。

1：与

2：或

AccurateRules Object[] 可选示例值：--

高级条件详情。

ValueString String 可选示例值：http

匹配具体内容。当 Opretar 设置为以下值时，无返回值，其余情况返回对应匹配内容。

17：判断为 IP

18：判断为 IPv4

19：判断为 IPv6

20：判断为私网 IP

21：判断为公网 IP

Opretar Integer 可选示例值：2

逻辑运算符。

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

ObjType Integer 可选示例值：0

操作的 http 对象对应匹配字段，与 HttpObj 存在映射关系。

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

HttpObj String 可选示例值：request.schema

操作的 http 对象，与 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。

Property Integer 可选示例值：0

对应 HttpObj 的值用于匹配操作对象详情。当Opretar设置为以下值时，该值为5，其余情况为0。

17：判断为 IP

18：判断为 IPv4

19：判断为 IPv6

20：判断为私网 IP

21：判断为公网 IP

错误码

您可访问公共错误码，获取更多错误码信息。

输入示例 1

输入示例

POST https://waf.volcengineapi.com/?Action=ListCustomPage&Version=2023-12-25

{
    "Page": 1,
    "RuleTag": "D000000001642",
    "Host": "example.com",
    "ProjectName": "default",
    "PageSize": 10
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListCustomPage",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 10,
        "CurrentPage": 1,
        "PageSize": 10,
        "Data": [
            {
                "Id": 1876,
                "Url": "/test/*",
                "Body": "<!DOCTYPE html> <html> <meta charset=\"utf-8\"> <body> <p> !!! 系统禁止访问 </p> </body> </html>",
                "Code": "403",
                "Host": "example.com",
                "Name": "自定义规则1",
                "Enable": 1,
                "Header": "Header",
                "Policy": 1,
                "GroupId": 9923,
                "RuleTag": "D000000000961",
                "Accurate": {
                    "Logic": 1,
                    "AccurateRules": [
                        {
                            "HttpObj": "request.schema",
                            "ObjType": 0,
                            "Opretar": 2,
                            "Property": 0,
                            "ValueString": "http"
                        }
                    ]
                },
                "Advanced": 1,
                "ClientIp": "ALL",
                "PageMode": 0,
                "UpdateTime": "2024-01-24T17:08:29+08:00",
                "ContentType": "text/html",
                "Description": "增加一条自定义响应拦截规则。",
                "IsolationId": "cn-beijing",
                "RedirectUrl": "RedirectUrl"
            }
        ]
    }
}

最近更新时间：2026.01.20 15:17:10

这个页面对您有帮助吗？

有用

无用