ModifyServiceDefenceMode - 更新域名防护模式--Web应用防火墙-火山引擎

文档中心

立即注册

导航

ModifyServiceDefenceMode - 更新域名防护模式

最近更新时间：2024.12.10 20:55:17首次发布时间：2024.12.10 20:55:17

已添加的域名默认为“启用防护”状态，即按域名对应的防护策略启用 WAF 防护。您可以调用 ModifyServiceDefenceMode 接口，更新指定域名的防护模式。

使用说明

ALB 接入方式下，存在多个实例同时接入且按实例维度回源。通过该方式接入的防护网站，支持在设定防护模式的基础上，配置例外实例，即为不同 ALB 实例的流量来源配置不同的防护模式。

未配置例外实例时，网站的防护模式即为基础防护模式，包括“启用防护/暂停防护/回源模式”。
如配置了例外实例，网站的防护模式会显示为“部分防护/部分暂停/部分回源”。

注意事项

防护模式会对 ALB 实例关联的所有域名同时生效。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
ExtraDefenceModeLBInstance	Array of Object	否	--	例外实例的防护模式。当接入模式为通过应用型负载均衡（ALB）实例接入（AccessMode=20）时生效。 ALB 实例接入模式下，存在多个实例同时接入且按实例维度回源。通过该方式接入的防护网站，支持在设定防护模式的基础上，配置例外实例，即为不同 ALB 实例的流量来源配置不同的防护模式。
Host	String	是	example.volcwaf001.com	需要修改防护模式的网站域名。
DefenceMode	Integer	否	1	实例的防护模式。 1：启用防护，已配置的防护策略生效。 2：暂停防护，仅执行转发而不检测，已配置的防护策略不生效。 3：回源模式，直接将请求解析至源站，不再转发至 WAF 实例。
ProjectName	String	否	default	所属项目资源名称，获取方式可参考ListDomain-查询云 WAF 实例防护网站信息。

返回参数

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

请求示例 1

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

{
  "ProjectName": "default",
  "Host": "albtest.volcwaf001.com",
  "DefenceMode": 1,
  "ExtraDefenceModeLBInstance": [
    {
      "InstanceID": "alb-hehyk9focem84ylwylrm****",
      "DefenceMode": 2
    }
  ]
}

返回示例 1

{
  "ResponseMetadata": {
    "RequestId": "202412102006272120040772061F544E",
    "Action": "ModifyServiceDefenceMode",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {}
}

请求示例 2

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

{
    "ProjectName": "default",
    "Host": "test.volcwaf001.com",
    "DefenceMode": 2
}

返回示例 2

{
  "ResponseMetadata": {
    "RequestId": "2024121020064808705619420713A41E",
    "Action": "ModifyServiceDefenceMode",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

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