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

文档中心

立即注册

导航

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

最近更新时间：2025.03.31 16:27:41首次发布时间：2024.02.01 14:25:21

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必填	示例值	描述
Action	String	是	ListCustomPage	要执行的操作，取值：ListCustomPage。
Version	String	是	2023-12-25	API的版本，取值：2023-12-25。

Body

参数	类型	是否必填	示例值	描述
Host	String	是	example.com	需要查看的域名。
ProjectName	String	否	default	所属项目资源名称，获取方式可参考ListDomain-查询云 WAF 实例防护网站信息。
PageSize	Integer	否	20	单个页面显示的条目数量上限。默认为 10。范围为 1～100。
Page	String	否	1	查询页码，默认为 1。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
PageNumber	Integer	10	当前页面显示的条目数量。
CurrentPage	Integer	1	当前页面的页码。
PageSize	Integer	10	单个页面显示的条目数量上限。
Data	Array of Object	--	规则详情。

请求示例

POST /?Action=ListCustomPage&Version=2023-12-25 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250328T093702Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250328/cn-beijing/waf/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202503281742350ED961ADA7B25674ECFE",
        "Action": "ListCustomPage",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "CurrentPage": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "Count": 1,
        "Data": [
            {
                "Accurate": {
                    "AccurateRules": [
                        {
                            "HttpObj": "request.uri",
                            "Id": 13712,
                            "ObjType": 1,
                            "Opretar": 2,
                            "Property": 0,
                            "ValueString": "111"
                        },
                        {
                            "HttpObj": "request.method",
                            "Id": 13713,
                            "ObjType": 2,
                            "Opretar": 5,
                            "Property": 0,
                            "ValueString": "get"
                        }
                    ],
                    "Logic": 1
                },
                "Advanced": 1,
                "Body": "<!DOCTYPE html> <html> <meta charset=\"utf-8\"> <body> <p> !!! 系统禁止访问 </p> </body> </html>",
                "ClientIp": "ALL",
                "Code": "400",
                "ContentType": "text/html",
                "Description": "",
                "Enable": 0,
                "GroupId": 9923,
                "Host": "example.com",
                "Id": 1876,
                "IsolationId": "cn-beijing",
                "Name": "1",
                "PageMode": 0,
                "Policy": 1,
                "RedirectUrl": "",
                "RuleTag": "D000000001876",
                "UpdateTime": "2025-03-28T17:26:23+08:00",
                "Url": "/*"
            }
        ]
    }
}

错误码

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