DescribeDefenseResourceTemplates - 查询防护对象或防护组的防护模板 - Web 应用防火墙

查询防护对象或防护组的防护模板。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-waf:DescribeDefenseResourceTemplates	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance ，查看当前 WAF 实例的 ID。	waf_v3prepaid_public_cn-9lb36****0e
Resource	string	是	要查询的防护对象或防护组名称。	mitsuichemicals.cn-waf
ResourceType	string	否	防护资源类型。取值： single（默认）：防护对象。 group：防护对象组。	single
RuleType	string	否	防护规则类型。取值： defense（默认）：防护规则 whitelist：白名单规则	whitelist
RuleId	long	否	防护规则的 ID。	20111098
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-aek2ax2y5****pi

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	2305CEB0-BA5A-5543-A1D3-3F1D08911B1C
Templates	array<object>	防护模板列表。
Template	object	防护模板。
Description	string	模板描述。	示例防护模板
TemplateOrigin	string	要创建的防护模板来源。取值为 custom，表示用户自定义。	custom
DefenseSubScene	string	防护模版子场景，取值： web：表示 BOT 管理网页防护场景模版。 app：表示 BOT 管理 APP 防护场景模版。 basic：表示 BOT 管理基础防护模版。	basic
DefenseScene	string	要创建的 WAF 防护场景，取值： waf_group：表示基础防护。 antiscan：表示扫描防护。 ip_blacklist：表示 IP 黑名单。 custom_acl：表示自定义规则。 whitelist：表示白名单。 region_block：表示区域封禁。 custom_response：表示自定义响应。 cc：表示 CC 防护。 tamperproof：表示网页防篡改。 dlp：表示信息泄露防护。	whitelist
GmtModified	long	防护模板创建时间，格式为时间戳，单位：毫秒。	1692930539000
TemplateName	string	防护模板名称。	WAF扫描防护
TemplateType	string	防护模板类型。取值： user_default：表示用户默认防护。 user_custom：表示用户自定义防护。	user_custom
TemplateId	long	防护模板 ID。	34328
TemplateStatus	integer	防护模板状态。取值： 0：表示关闭。 1：表示开启。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "2305CEB0-BA5A-5543-A1D3-3F1D08911B1C",
  "Templates": [
    {
      "Description": "示例防护模板",
      "TemplateOrigin": "custom",
      "DefenseSubScene": "basic",
      "DefenseScene": "whitelist",
      "GmtModified": 1692930539000,
      "TemplateName": "WAF扫描防护",
      "TemplateType": "user_custom",
      "TemplateId": 34328,
      "TemplateStatus": 1
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史