文档

SetDomainRuleGroup - 为域名配置防护规则组

为指定域名配置选择正则防护引擎使用的防护规则组,除系统默认的三种防护规则组外,也可以选择自定义规则组。

接口说明

使用说明

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

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

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

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-waf:SetDomainRuleGroupWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Domainsstring

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

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

说明 您可以调用 DescribeDomainList 查询所有已接入 WAF 防护的域名。
["www.aliyundoc.com"]
RuleGroupIdlong

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

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

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

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

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

1
InstanceIdstring

WAF 实例 ID。

说明 您可以通过调用 DescribeInstanceInfo 接口查看当前 WAF 实例 ID。
waf-cn-tl32ast****
ResourceGroupIdstring

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

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

rg-acfm2pz25js****
WafAiStatusinteger

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

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

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

1
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

D7861F61-5B61-46CE-A47C-6B19****5EB0

示例

正常返回示例

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19****5EB0"
}

错误码

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

  • 本页导读 (1)