DescribeDcdnWafGroup - 查询自定义WAF规则组详情

调用DescribeDcdnWafGroup查询自定义WAF规则组细则,具体规则可分页。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dcdn:DescribeDcdnWafGroup

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Language

string

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

  • en:英文。

  • zh:中文。

zh

Id

integer

WAF 规则组 ID。您可以通过 DescribeDcdnWafGroups 接口查询。

1012

Scope

string

待查询规则组的范围。

  • in:规则内,返回该规则组内的规则。

  • out:规则外,返回在规则全集中并且不在该规则组中的规则。

in

QueryArgs

string

查询条件,JSON 序列化后的字符串。格式如下:

QueryArgs={"PolicyIds":"防护策略 ID 范围","RuleIds":"防护规则 ID 范围","RuleNameLike":"防护规则名称","DomainNames":"防护域名","DefenseScenes":"waf_group","RuleStatus":"on","OrderBy":"GmtModified","Desc":"false"}

说明

不传默认查询所有防护规则。

{"RiskLevel":"","ProtectionType":"","ApplicationType":"","RuleIdLike":""}

PageNumber

integer

当前页码,默认值 1

1

PageSize

integer

分页大小,默认 20

20

返回参数

名称

类型

描述

示例值

object

请求 ID。

RequestId

string

请求 ID。

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

Id

integer

自定义 WAF 规则组 ID。

1012

Name

string

WAF 规则组名称。

test

TemplateId

integer

模板 ID。

1012

Subscribe

string

是否开启订阅。取值:

  • on:开启。

  • off:关闭。

on

TotalCount

integer

过滤出的规则总数。

16

Rules

array<object>

规则结构体。

object

规则结构体。

GmtModified

string

修改时间。

2021-12-29T17:08:45Z

Id

integer

自定义 WAF 规则 ID。

100001

Name

string

WAF 规则名称。

test

Description

string

WAF 规则描述。

OK

RiskLevel

integer

规则风险等级。取值:

  • 0:高风险。

  • 1:中风险。

  • 2:低风险。

2

ProtectionType

integer

防护类型。取值如下:

  • 11:SQL 注入

  • 12:跨站脚本

  • 13:代码执行

  • 14:CRLF

  • 15:本地文件包含

  • 16:远程文件包含

  • 17:webshell

  • 19:跨站请求伪造

  • 20:其他

  • 21:SEMA

11

ApplicationType

integer

应用类型。取值如下:

  • 0:Common

  • 1:Wordpress

  • 2:Dedecms

  • 3:Discuz

  • 4:Phpcms

  • 5:Ecshop

  • 6:Shopex

  • 8:Drupal

  • 8:Joomla

  • 9:Metinfo

  • 10:Struts2

  • 11:Spring Boot

  • 12:Jboss

  • 13:Weblogic

  • 14:Websphere

  • 15:Tomcat

  • 16:Elastic Search

  • 18:Thinkphp

  • 19:Fastjson

  • 20:ImageMagick

  • 21:PHPwind

  • 22:phpMyAdmin

  • 23:Resin

  • 24:IIS

  • 99:Others

1

CveId

string

CVE ID。

CVE-2021-22945

CveUrl

string

CVE 链接。

https://nxx.nxxx.gov/vuln/detail/CVE-2022-XXXX

PageNumber

integer

页码。

1

PageSize

integer

分页大小,默认 20

20

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Id": 1012,
  "Name": "test",
  "TemplateId": 1012,
  "Subscribe": "on",
  "TotalCount": 16,
  "Rules": [
    {
      "GmtModified": "2021-12-29T17:08:45Z",
      "Id": 100001,
      "Name": "test",
      "Description": "OK",
      "RiskLevel": 2,
      "ProtectionType": 11,
      "ApplicationType": 1,
      "CveId": "CVE-2021-22945",
      "CveUrl": "https://nxx.nxxx.gov/vuln/detail/CVE-2022-XXXX"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20
}

错误码

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

变更历史

更多信息,参考变更详情