CreateCustomPage - 创建自定义响应拦截规则--Web应用防火墙-火山引擎

文档中心

立即注册

导航

CreateCustomPage - 创建自定义响应拦截规则

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

调用 CreateCustomPage 接口创建自定义响应拦截规则，当满足条件的请求被 WAF 拦截时返回特定信息（CC 拦截除外），如自定义的响应码和响应页面。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
Host	String	是	example.volcwaf001.com	需要添加防护规则的域名。
Policy	Integer	是	1	策略执行动作： 1 : 观察 8：拦截
ClientIp	String	是	ALL	生效 IP 范围，需填写 `ALL`，即对所有 IP 生效。
Name	String	是	自定义规则1	规则名称，支持英文、汉字、数字, 不支持特殊字符，长度限制在 20 个字符内。
Description	String	否	增加一条自定义响应拦截规则。	规则备注。
Url	String	是	/test	匹配路径。支持通配符``，``只能出现一次。某个具体的 URL 地址，例如需要放行`test.com/test.html`，则填写`/test.html`。针对整个网站，则填写``即可。某个路径前缀适配的所有地址，例如`/test/`。
Enable	Integer	是	1	规则开关，默认为开启。 0：关闭 1：开启
Code	Integer	是	403	自定义 HTTP 返回码。
PageMode	Integer	是	0	响应页面模板。 0：系统默认 1：自定义 2：重定向
ContentType	String	否	text/html	页面类型。 text/html text/xml application/json
Body	String	否	!!! 系统禁止访问	页面内容。当`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`时，支持自定义内容。
Advanced	Integer	否	1	是否配置高级条件。 0：否 1：是
RedirectUrl	String	否	/test/path1	重定向匹配路径，`PageMode=2`时需要填写。
ProjectName	String	否	default	所属项目资源名称，获取方式可参考ListDomain-查询云 WAF 实例防护网站信息。
Accurate	Object	否	--	高级条件详情，`Advanced=1`时需要填写。

返回参数

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

参数	类型	示例值	描述
Id	Integer	1876	规则 ID。

请求示例

POST https://open.volcengineapi.com/?Action=CreateCustomPage&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",
    "Policy": 1,
    "ClientIp": "ALL",
    "Name": "自定义规则1",
    "Url": "/test",
    "Enable": 1,
    "Code": 403,
    "PageMode": 0,
    "ContentType": "text/html",
    "Body": "<!DOCTYPE html> <html> <meta charset=\"utf-8\"> <body> <p> !!! 系统禁止访问 </p> </body> </html>",
    "Advanced": 1,
    "Accurate": {
        "Logic": 1,
        "AccurateRules": [
            {
                "Property": 0,
                "HttpObj": "request.uri",
                "ObjType": 1,
                "Opretar": 6,
                "ValueString": "1=1"
            }
        ]
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024010415315213210E05F83D5BF4****",
        "Action": "custompage",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": 1876
    }
}

错误码

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