全部产品
Search

搜索本产品

    Web 应用防火墙：DescribeDefenseTemplates - 分页查询防护模板列表

    文档中心

    Web 应用防火墙：DescribeDefenseTemplates - 分页查询防护模板列表

    更新时间：Sep 13, 2024

    分页查询防护模板列表。

    调试

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

    授权信息

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

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

    请求参数

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

    WAF 实例的 ID。

    说明 您可以调用 DescribeInstance ，查看当前 WAF 实例的 ID。
    		waf_v3prepaid_public_cn-pe33b****03
    TemplateIdlong否

    防护模板 ID。

    		39395
    TemplateTypestring否

    要创建的防护模板类型。取值：

    • user_default：表示用户默认防护。
    • user_custom：表示用户自定义防护。
    		user_default
    DefenseScenestring否

    要创建的 WAF 防护场景，取值：

    • waf_group：表示基础防护。

    • antiscan：表示扫描防护。

    • ip_blacklist：表示 IP 黑名单。

    • custom_acl：表示自定义规则。

    • whitelist：表示白名单。

    • region_block：表示区域封禁。

    • custom_response：表示自定义响应。

    • cc：表示 CC 防护。

    • tamperproof：表示网页防篡改。

    • dlp：表示信息泄露防护。

    		region_block
    Resourcestring否

    防护对象或防护组名称。

    说明 和 ResourceType 字段搭配使用，筛选生效时，两个字段都需要有值。
    		ruiqiu.cc-ecs
    ResourceTypestring否

    防护资源类型。取值：

    • single（默认）：防护对象。
    • group：防护对象组。
    说明 和 Resource 字段搭配使用，筛选生效时，两个字段都需要有值。
    		single
    DefenseSubScenestring否

    防护模版子场景，取值：

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

    分页查询请求时返回的页码。默认值为 1。

    		1
    PageSizeinteger否

    分页查询时每页的行数。默认值为 20。

    		10
    RegionIdstring否

    WAF 实例所属地域。取值：

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

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

    		cn-hangzhou
    ResourceManagerResourceGroupIdstring否

    阿里云资源组 ID。

    		rg-acfmvyknl****fa

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		4F26D2F1-E288-5104-8518-05E240E337A4
    TotalCountlong

    返回结果的总数。

    		100
    Templatesarray<object>

    防护模板列表。

    object

    防护模板。

    DefenseScenestring

    要创建的 WAF 防护场景，取值：

    • waf_group：表示基础防护。

    • antiscan：表示扫描防护。

    • ip_blacklist：表示 IP 黑名单。

    • custom_acl：表示自定义规则。

    • whitelist：表示白名单。

    • region_block：表示区域封禁。

    • custom_response：表示自定义响应。

    • cc：表示 CC 防护。

    • tamperproof：表示网页防篡改。

    • dlp：表示信息泄露防护。

    		whitelist
    GmtModifiedlong

    防护模板的创建时间，格式为时间戳，单位：毫秒。

    		1683776070000
    TemplateIdlong

    防护模板 ID。

    		56477
    TemplateNamestring

    防护模板名称。

    		template-blockarea1
    TemplateOriginstring

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

    		custom
    TemplateStatusinteger

    防护模板状态。取值：

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

    要创建的防护模板类型。取值：

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

    防护模版子场景，取值：

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

    该模板的描述信息。

    		示例防护模板。

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "4F26D2F1-E288-5104-8518-05E240E337A4",
  "TotalCount": 100,
  "Templates": [
    {
      "DefenseScene": "whitelist",
      "GmtModified": 1683776070000,
      "TemplateId": 56477,
      "TemplateName": "template-blockarea1",
      "TemplateOrigin": "custom",
      "TemplateStatus": 1,
      "TemplateType": "user_custom",
      "DefenseSubScene": "basic",
      "Description": "示例防护模板。"
    }
  ]
}

    错误码

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