全部产品
Search
文档中心

Web 应用防火墙:DescribeDefenseRules - 分页查询防护规则

更新时间:Nov 15, 2024

分页查询防护规则。

调试

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

授权信息

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

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

请求参数

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

WAF 实例 ID。

说明 您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。
waf_cdnsdf3****
RuleTypestring

防护规则类型。取值:

  • whitelist:白名单规则
  • defense(默认):防护规则
whitelist
Querystring

查询条件,以一系列参数构造的 JSON 格式转化成字符串。

说明 根据不同的查询条件,查询到的防护规则结果不同。详细信息,请参见Query 参数描述
{\"name\":\"IP压制_20220822_10\",\"scene\":\"custom_acl\",\"templateId\":5327}
PageNumberinteger

分页查询时,返回第几页数据。默认值为 1,表示返回第 1 页数据。

1
PageSizeinteger

分页查询时,每页包含多少条结果。默认值为 10,表示每页包含 10 条结果。

10
RegionIdstring

WAF 实例所属地域。取值:

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

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

cn-hangzhou
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q

Query 参数详解

参数描述

名称类型是否必选示例值描述
nameString可选test要查询的防护规则名称。您可以设置该参数,精确查询某条防护规则。
nameIdString可选test1要查询的防护规则 ID 或名称。您可以设置该参数,模糊查询某条防护规则。
nameLikeString可选test.aliyundoc.c要查询的防护规则名称。您可以设置该参数,模糊查询某条防护规则。
sceneString可选waf_group要查询的防护场景。您可以设置该参数,精确查询某个防护场景的防护规则。取值范围请参见 CreateDefenseRuleDefenseScene 参数。
ruleIdLong可选33444要查询的防护规则 ID。您可以设置该参数,精确查询某条防护规则。
ruleIdInArray可选[3334455643,345555]要查询的防护规则 ID 范围。您可以设置该参数,查询多个防护规则。多个防护规则之间使用英文逗号(,)分隔。
templateIdLong可选24354要查询的防护模板 ID。您可以设置该参数,查询某个防护模板中的防护规则。
orderByString可选name设置防护规则排序方式。取值:
- name : 表示按防护规则名称排序。
- gmtModified : 表示按防护规则修改时间排序。
- id : 表示按规则 ID 排序。
- templateId : 表示按防护模板 ID 排序。
descBoolean可选true设置排序顺序。取值:
- false : 表示正序显示。
- true : 表示倒序显示。

示例

{
    "name": "test",
    "nameId ": "test1,
    "nameLike": "test.aliyundoc.c",
    "nameIn": "test.aliyundoc.c",
    "InstaneId": "test1.aliyundoc.com,test2.aliyundoc.com",
    "templateId": 24354
}

返回参数

名称类型描述示例值
object

请求结果。

TotalCountlong

返回结果的总数。

2
RequestIdstring

请求 ID。

80736FA5-FA87-55F6-AA69-C5477C6FE6D0
Rulesarray<object>

防护规则列表。

Ruleobject

防护规则列表。

Statusinteger

防护规则状态。取值:

  • 0:表示已禁用。

  • 1:表示已启用。

1
DefenseOriginstring

防护来源。取值:

  • custom:用户自定义。

  • system:系统自动生成。

custom
Configstring

防护规则详情,以一系列参数构造的 JSON 格式转化成字符串。更多信息,请参见 CreateDefenseRuleRule 参数具体说明

{\"policyId\":1012,\"action\":\"block\"}
RuleIdlong

防护规则 ID。

42755
DefenseScenestring

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

waf_group
GmtModifiedlong

防护规则修改时间。

1665460629000
RuleNamestring

防护规则名称。

rules_41
TemplateIdlong

防护规则模板 ID。

5673

示例

正常返回示例

JSON格式

{
  "TotalCount": 2,
  "RequestId": "80736FA5-FA87-55F6-AA69-C5477C6FE6D0",
  "Rules": [
    {
      "Status": 1,
      "DefenseOrigin": "custom",
      "Config": "{\\\"policyId\\\":1012,\\\"action\\\":\\\"block\\\"}",
      "RuleId": 42755,
      "DefenseScene": "waf_group",
      "GmtModified": 1665460629000,
      "RuleName": "rules_41",
      "TemplateId": 5673
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史