文档

DescribeDefenseTemplate - 查询单个防护模板

更新时间:

查询单个防护模板。

调试

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

授权信息

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

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

请求参数

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

WAF 实例的 ID。

说明 您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。
waf_cdnsdf3****
TemplateIdlong

要查询的防护模板 ID。

1333
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q
RegionIdstring

WAF 实例所属地域。取值:

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

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

cn-hangzhou

返回参数

名称类型描述示例值
object

请求结果。

RequestIdstring

请求 ID。

D7861F61-5B61-46CE-A47C-6B19160D5EB0
Templateobject

模板信息。

DefenseScenestring

防护场景。更多信息,请参见 CreateDefenseRuleDefenseScene 参数。

waf_group
GmtModifiedlong

防护模板修改时间。

1665283642000
TemplateIdlong

防护规则模板 ID。

10097
TemplateNamestring

模板名称。

test0621
TemplateOriginstring

要创建的防护模板来源。取值为 custom,表示用户自定义。

custom
TemplateStatusinteger

防护模板状态。取值:

  • 0:表示关闭。
  • 1:表示开启。
1
TemplateTypestring

防护模板类型。取值:

  • user_default:表示用户默认防护。
  • user_custom:表示用户自定义防护。
user_default
DefenseSubScenestring

防护模版子场景,取值:

  • web:表示 BOT 管理网页防护场景模版。
  • app:表示 BOT 管理 APP 防护场景模版。
  • basic:表示 BOT 管理基础防护模版。
app
Descriptionstring

要创建的防护模板描述信息。

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-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)