ListCustomPage-查询自定义响应拦截规则详情--Web应用防火墙-火山引擎

文档中心

立即注册

导航

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

最近更新时间：2024.03.01 16:47:39首次发布时间：2024.02.01 14:25:21

查询指定域名下自定义响应拦截规则详情。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListCustomPage&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

参数	类型	示例值	描述
Host	String	`example.volcwaf001.com`	域名。
Id	Integer	`923`	规则 ID。
ContentType	String	`1`	页面类型。 text/html text/xml application/json
Code	Integer	`403`	HTTP 返回码。
PageMode	Integer	`0`	响应页面模板。 0：系统默认 1：自定义 2：重定向
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`时，显示为自定义内容。
Name	String	`testwaf`	规则名称。
ClientIp	String	`ALL`	生效 IP 范围，对所有 IP 生效。
Url	String	`/test`	匹配路径。
Enable	Integer	`1`	规则开关。默认为开启。 0：关闭 1：开启
Advanced	Integer	`1`	是否配置高级条件。 0：否 1：是
Accurate	Accurate object	-	`Advanced=1`时显示。
Description	String	`增加一条自定义响应拦截规则。`	规则备注。

Accurate

参数	类型	示例值	描述
AccurateRules	Array of AccurateRules objects	-	规则详情。
Logic	Integer	`1`	高级条件的逻辑关系。 1：与 2：或

参数

类型

示例值

描述

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=ListCustomPage&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": "202401041645522860E858CE5F0318****",
        "Action": "ListCustomPage",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-guilin"
    },
    "Result": {  
            "TotalCount": 1,
            "PageSize": 10,
            "CurrentPage": 1,
            "Count": 1,
            "Data": [
            {
                "Advanced": 0,
                "Body": "\u003c!DOCTYPE html\u003e \u003chtml\u003e \u003cmeta charset=\"utf-8\"\u003e \u003cbody\u003e \u003cp\u003e !!! 系统禁止访问 \u003c/p\u003e \u003c/body\u003e \u003c/html\u003e",
                "ClientIp": "ALL",
                "Code": 403,
                "ContentType": "text/html",
                "Description": "",
                "Enable": 1,
                "GroupId": 0,
                "Host": "test.com",
                "Id": 924,
                "IsolationId": "cn-guilin",
                "Name": "acb",
                "PageMode": 0,
                "Policy": 1,
                "RedirectUrl": "",
                "RuleTag": "D000000000924",
                "UpdateTime": "2024-01-04T16:45:51+08:00",
                "Url": "/*"
            }
        ]
    }
}