You need to enable JavaScript to run this app.
导航
UpdateCustomPage - 更新自定义响应拦截规则
最近更新时间:2025.03.31 16:27:41首次发布时间:2024.02.01 14:25:21
我的收藏
有用
有用
无用
无用

调用 UpdateCustomPage 接口更新自定义响应拦截规则。

请求说明

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

调试

请求参数

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

Query

参数
类型
是否必填
示例值
描述
Action
String

UpdateCustomPage

要执行的操作,取值:UpdateCustomPage。

Version
String

2023-12-25

API的版本,取值:2023-12-25。

Body

参数
类型
是否必填
示例值
描述
Policy
Integer

1

执行策略动作:

  • 1 : 观察
  • 8:拦截
RedirectUrl
String

/test/Path1

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

Id
Integer

1876

规则 ID,获取方式可参考ListCustomPage-查询自定义响应拦截规则详情

GroupId
Integer

9922

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

Advanced
Integer

1

是否配置高级条件。

  • 0:否
  • 1:是
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时,支持自定义内容。

ContentType
String

text/html

页面类型。

  • text/html
  • text/xml
  • application/json
PageMode
Integer

0

响应页面模板。

  • 0:系统默认
  • 1:自定义
  • 2:重定向
Code
Integer

403

自定义 HTTP 返回码。

Enable
Integer

1

规则开关,默认为开启。

  • 0:关闭
  • 1:开启
Url
String

/test

匹配路径。支持通配符**只能出现一次。

  • 某个具体的 URL 地址,例如需要放行test.com/test.html,则填写/test.html
  • 针对整个网站,则填写*即可。
  • 某个路径前缀适配的所有地址,例如/test/*
Description
String

增加一条自定义响应拦截规则。

规则备注。

Name
String

自定义规则1

规则名称,支持英文、汉字、数字, 不支持特殊字符,长度限制在 20 个字符内。

ClientIp
String

ALL

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

Host
String

example.volcwaf001.com

防护规则关联的域名。

ProjectName
String

default

所属项目资源名称,获取方式可参考ListDomain-查询云 WAF 实例防护网站信息

Accurate
Object

--

高级条件详情,Advanced=1时需要填写。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

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

{
    "ProjectName": "default",
    "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": 1,
    "GroupId": 9923,
    "Host": "example.volcwaf001.com",
    "Id": 1876,
    "IsolationId": "cn-beijing",
    "Name": "1",
    "PageMode": 0,
    "Policy": 1,
    "RedirectUrl": "",
    "UpdateTime": "2025-03-28T17:26:23+08:00",
    "Url": "/*"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240104161554508548FB743E0FDB****",
        "Action": "UpdateCustomPage",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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