调用 UpdateCustomPage 接口更新自定义响应拦截规则。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateCustomPage | 要执行的操作,取值:UpdateCustomPage。 |
Version | String | 是 | 2023-12-25 | API的版本,取值:2023-12-25。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Policy | Integer | 是 | 1 | 执行策略动作:
|
RedirectUrl | String | 否 | /test/Path1 | 重定向匹配路径, |
Id | Integer | 是 | 1876 | 规则 ID,获取方式可参考ListCustomPage-查询自定义响应拦截规则详情。 |
GroupId | Integer | 否 | 9922 | 高级条件规则组 ID,获取方式可参考ListCustomPage-查询自定义响应拦截规则详情。 |
Advanced | Integer | 否 | 1 | 是否配置高级条件。
|
Body | String | 否 | !!! 系统禁止访问 | 页面内容。
|
ContentType | String | 否 | text/html | 页面类型。
|
PageMode | Integer | 是 | 0 | 响应页面模板。
|
Code | Integer | 是 | 403 | 自定义 HTTP 返回码。 |
Enable | Integer | 是 | 1 | 规则开关,默认为开启。
|
Url | String | 是 | /test | 匹配路径。支持通配符
|
Description | String | 否 | 增加一条自定义响应拦截规则。 | 规则备注。 |
Name | String | 是 | 自定义规则1 | 规则名称,支持英文、汉字、数字, 不支持特殊字符,长度限制在 20 个字符内。 |
ClientIp | String | 是 | ALL | 生效 IP 范围,需填写 |
Host | String | 是 | example.volcwaf001.com | 防护规则关联的域名。 |
ProjectName | String | 否 | default | 所属项目资源名称,获取方式可参考ListDomain-查询云 WAF 实例防护网站信息。 |
Accurate | Object | 否 | -- | 高级条件详情, |
本接口无特有的返回参数。更多信息请见返回结构。
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 }
您可访问公共错误码,获取更多错误码信息。