调用SetDomainRuleGroup为域名设置规则防护引擎的防护规则组及智能规则托管功能的启用状态。

使用说明

本接口用于为指定域名设置规则防护引擎的防护规则组及智能规则托管功能的启用状态。

设置防护规则组时,除了可以使用WAF内置的正常、严格和宽松防护规则组,您还可以选择自定义规则组。

注意 目前暂不支持通过API创建自定义规则组。您必须先在Web应用防火墙控制台系统管理 > 防护规则组页面,新建规则组并获得对应规则组ID后,才可以调用本接口,为域名应用自定义规则组。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SetDomainRuleGroup

要执行的操作。取值:SetDomainRuleGroup

Domains String ["www.aliyundoc.com"]

要设置防护规则组的域名列表。使用数组转化的字符串格式表示。

支持同时设置多个域名,格式:["<域名1>","<域名2>",……]

说明 您可以调用DescribeDomainList查询所有已接入WAF防护的域名。
RuleGroupId Long 1012

为规则防护引擎设置要应用的防护规则组ID。取值:

  • 1011:表示WAF内置的严格规则组。
  • 1012:表示WAF内置的中等规则组。
  • 1013:表示WAF内置的宽松规则组。

除了以上内置规则组外,您还可以设置自定义规则组的ID。

说明 您可以在Web应用防火墙控制台防护规则组页面,获取自定义规则组的ID。
WafVersion Long 1

为当前配置设置一个版本号(用于实现乐观锁控制)。

InstanceId String waf-cn-tl32ast****

WAF实例ID。

说明 您可以通过调用DescribeInstanceInfo接口查看当前WAF实例ID。
ResourceGroupId String rg-acfm2pz25js****

网站域名在资源管理服务中所属的资源组ID。

不设置该参数表示默认资源组。

WafAiStatus Integer 1

设置智能规则托管功能的启用状态。取值:

  • 0:表示关闭。
  • 1(默认):表示开启。

智能规则托管表示由WAF智能学习历史业务流量的行为模式,识别可能对正常业务产生误拦截的防护规则,并通过自动设置Web入侵防护白名单,在特定业务防护场景下屏蔽对应防护规则。等误报风险消除后,再恢复使用被屏蔽的防护规则。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

本次请求的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=SetDomainRuleGroup
&Domains=["www.aliyundoc.com"]
&RuleGroupId=1012
&InstanceId=waf-cn-tl32ast****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SetDomainRuleGroupResponse>
    <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
</SetDomainRuleGroupResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}

错误码

访问错误中心查看更多错误码。