DescribeDefenseTemplate - 查询单个防护模板 - Web 应用防火墙

查询单个防护模板。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。	waf_cdnsdf3****
TemplateId	long	是	要查询的防护模板 ID。	1333
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q

返回参数

名称	类型	描述	示例值
	object	请求结果。
RequestId	string	请求 ID。	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Template	object	模板信息。
DefenseScene	string	防护场景。更多信息，请参见 CreateDefenseRule 的 DefenseScene 参数。	waf_group
GmtModified	long	防护模板修改时间。	1665283642000
TemplateId	long	防护规则模板 ID。	10097
TemplateName	string	模板名称。	test0621
TemplateOrigin	string	要创建的防护模板来源。取值为 custom，表示用户自定义。	custom
TemplateStatus	integer	防护模板状态。取值： 0：表示关闭。 1：表示开启。	1
TemplateType	string	防护模板类型。取值： user_default：表示用户默认防护。 user_custom：表示用户自定义防护。	user_default
DefenseSubScene	string	防护模版子场景，取值： web：表示 BOT 管理网页防护场景模版。 app：表示 BOT 管理 APP 防护场景模版。 basic：表示 BOT 管理基础防护模版。	app
Description	string	要创建的防护模板描述信息。	test

示例

正常返回示例

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Template": {
    "DefenseScene": "waf_group",
    "GmtModified": 1665283642000,
    "TemplateId": 10097,
    "TemplateName": "test0621",
    "TemplateOrigin": "custom",
    "TemplateStatus": 1,
    "TemplateType": "user_default",
    "DefenseSubScene": "app",
    "Description": "test"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-07-26	OpenAPI 返回结构发生变更	查看变更详情