调用CreateDefenseTemplate接口创建防护模板-Web应用防火墙-阿里云-Web应用防火墙(WAF)-阿里云帮助中心

创建防护模板

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:CreateDefenseTemplate

create

*全部资源

*

acs:ResourceGroupId

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance 获取当前 WAF 实例的 ID。	waf_cdnsdf3****
TemplateName	string	是	要创建的防护模板名称。长度为 1~255 个字符，可以包含中文、英文、数字、下划线（_）、半角句号（.）或者短划线（-）。说明相同防护场景（DefenseScene）的模板名称不能重复。	test221
TemplateType	string	是	要创建的防护模板类型。取值： user_default：表示用户默认防护。 user_custom：表示用户自定义防护。	user_default
TemplateStatus	integer	是	要创建的防护模板状态。取值： 0：表示关闭。 1：表示开启。	1
DefenseScene	string	是	防护场景。更多信息，请参见 CreateDefenseRule 的 DefenseScene 参数。	waf_group
TemplateOrigin	string	是	要创建的防护模板来源。取值为 custom，表示用户自定义。	custom
DefenseSubScene	string	否	防护模版子场景。仅 BOT 管理高级场景支持配置。枚举值： app : 表示 app 场景模版 web : 表示 web 场景模版 bot_custom_acl : 表示高级自定义规则模版	web
Description	string	否	要创建的防护模板描述信息。	test
Detail	string	否	具体模板信息，JSON 格式的字符串，不同的键值对表示防护对象不同的属性，详见 Detail 解释。说明该参数仅适用于新版基础防护（waf_base）和新版 BOT 管理（bot_manager）防护场景。在新版 BOT 管理（bot_manager）防护场景下，必须传入该参数。	{"trafficFeature":"{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"}
DryRun	boolean	否	是否开启 DryRun 预检模式。如果不输入该参数，表示发起正常请求。取值： true：表示发起预检请求，仅检查请求是否满足执行条件，不执行请求指定的操作。预检不通过时返回相应错误码；预检通过时返回错误码 Defense.Control.DryRunOperation。 false：表示发起正常请求；检查通过后执行请求指定的操作。	false
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q
UnbindResources	array	否	创建默认防护模版时解除绑定的防护对象，使用["XX1","XX2",……]格式。说明该参数只在创建默认模版（TemplateType 取值为user_default）时生效。
	string	否	解除绑定的防护对象。	abc
UnbindResourceGroups	array	否	创建默认防护模版时解除绑定的防护对象组，使用["group1","group2",……]格式。说明该参数只在创建默认模版（TemplateType 取值为user_default）时生效。
	string	否	解除绑定的防护对象组。	group1

Detail 参数描述

防护模版在不同的防护场景（DefenseScene），Detail 参数内容不同。

新版 Web 核心防护（waf_base）

参数说明

名称	类型	是否必选	示例值	描述
aiWhitelistStatus	integer	可选	1	新版基础防护的智能加白引擎状态。取值： - 0（默认）：表示关闭。 - 1：表示开启。

示例

{
  "aiWhitelistStatus": 1
}

新版 BOT 管理（bot_manager）

参数说明

名称	类型	是否必选	示例值	描述
trafficFeature	String	可选	{"global":1,"excludeStatus":1,"staticFile":".css,.js,.jpg,……"}	BOT 管理防护模板的防护范围配置，以 JSON 字符串格式进行描述。当防护场景（DefenseScene）为 bot_manager 时必选。具体配置信息，请参见trafficFeature 详细配置。

trafficFeature 详细配置

名称	类型	是否必选	示例值	描述
global	Integer	必选	1	防护范围是否为全站。取值： - 0：表示自定义防护范围，需通过 conditions 指定生效的流量特征。 - 1：表示全局防护，即模板对该防护对象的全部请求生效。
excludeStatus	Integer	可选	1	是否排除静态资源，即命中 staticFile 中静态文件后缀的请求不进入 BOT 防护。取值： - 0：表示不排除静态资源。 - 1：表示排除静态资源，需通过 staticFile 指定要排除的静态文件后缀。
staticFile	String	可选	.7z,.aac,.css,.js,.jpg,.png,.pdf,.zip,……	要排除的静态文件后缀列表，以半角逗号（,）分隔的字符串表示，每个后缀以半角句号（.）开头。仅 excludeStatus 配置为 1 时，配置该信息。
conditions	Array	可选	[{"key":"URL","opValue":"not-contain","values":"test"}]	自定义防护范围的流量特征，以 JSON 字符串格式进行描述。仅 global 配置为 0 时，允许配置该信息。具体配置信息，请参见防护规则参数配置说明中 conditions 配置说明。

示例

{
  "trafficFeature": "{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"
}

返回参数

名称	类型	描述	示例值
	object	请求返回结构体。
RequestId	string	请求 ID。	F48ABDF7-D777-5F26-892A-57349765D7A9
TemplateId	integer	防护模板 ID。	2212

示例

正常返回示例

JSON格式

{
  "RequestId": "F48ABDF7-D777-5F26-892A-57349765D7A9",
  "TemplateId": 2212
}

错误码

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

变更历史

更多信息，参考变更详情。