DescribeDcdnWafGroups - 查询自定义WAF规则组列表

调用DescribeDcdnWafGroups查询自定义WAF规则组列表。

调试

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

授权信息

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

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

请求参数

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

语言类型,将以此语言返回。取值范围:

  • en:英文(默认)。
  • zh:中文。
zh
QueryArgsstring

查询条件,JSON 序列化后的字符串。格式如下: QueryArgs={"PolicyIds":"防护策略 ID 范围","RuleIds":"防护规则 ID 范围","RuleNameLike":"防护规则名称","DomainNames":"防护域名","DefenseScenes":"waf_group","RuleStatus":"on","OrderBy":"GmtModified","Desc":"false"}

说明 不传默认查询所有防护规则。
{"RuleIds":"100001,200002"}
PageNumberinteger

当前页码,默认值 1

1
PageSizeinteger

分页大小,默认 20

20

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
TotalCountinteger

WAF 规则组总数。

16
WafGroupsarray<object>

WAF 规则组列表。

WafGroupItemobject

WAF 规则组列表。

GmtModifiedstring

修改时间。

2020-04-12 22:25:11
Idlong

自定义 WAF 规则组 ID。

30000156
Namestring

WAF 规则名称。

DCDN-test-operation-reports-1
RuleCountinteger

规则数量。

452
TemplateIdlong

模板 ID。

1012
Subscribestring

是否开启订阅。取值范围:

  • on:开启订阅。
  • off:关闭订阅。
on
Policiesarray<object>

绑定该 WAF 规则组的策略。

PolicyItemobject

绑定该 WAF 规则组的策略。

Idlong

策略 ID。

30000165
Namestring

策略名称。

wasm-testmaster
Typestring

策略类型。取值范围:

  • custom:自定义策略。
  • default:默认策略。
default
PageNumberinteger

页码,默认值为 1。

1
PageSizeinteger

分页大小,默认 20

20

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 16,
  "WafGroups": [
    {
      "GmtModified": "2020-04-12 22:25:11",
      "Id": 30000156,
      "Name": "DCDN-test-operation-reports-1",
      "RuleCount": 452,
      "TemplateId": 1012,
      "Subscribe": "on",
      "Policies": [
        {
          "Id": 30000165,
          "Name": "wasm-testmaster",
          "Type": "default"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 20
}

错误码

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

变更历史

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