全部产品
Search
文档中心

边缘安全加速:DescribeDcdnWafFilterInfo - 获取自定义防护规则的匹配条件信息

更新时间:Oct 17, 2024

调用DescribeDcdnWafFilterInfo查询自定义防护规则中匹配条件的匹配字段、逻辑符和匹配内容等信息。

接口说明

说明 单用户调用频率:20 次/秒。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

防护策略类型列表,多个用逗号(,)分隔。目前支持以下场景:

  • waf_group:Web 基础防护

  • custom_acl:自定义防护策略

  • whitelist:白名单

说明 不传时,代表返回全部信息。
custom_acl
Languagestring

设置返回信息语言。取值范围:

  • en(默认):英文

  • cn:简体中文

cn

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

153ca2cd-3c01-44be-204c-64dbc6c88630
Contentarray<object>

查询到的信息。

FilterInfoobject
DefenseScenestring

防护策略类型,同请求参数的 DefenseScene。

custom_acl
Fieldsarray<object>

匹配条件信息。

Fieldobject
ExtendFieldstring

匹配字段的扩展 tip,无此字段或此字段为空表示无扩展字段。

自定义Header
MatchFieldstring

匹配字段。

Header
LogicalSymbolarray<object>

逻辑符。

Logicobject
Typestring

可输入的匹配内容个数,取值:

  • multi:可输入多个匹配内容。

  • single:仅可输入单个匹配内容。

  • none:不能输入。

multi
Symbolstring

代码内部传给后端逻辑符。

match-one
Tipstring

匹配内容中显示的提示信息。

可以输入多个,最多50个,按回车键确认
Attributesinteger

可设置的属性,位域变量,具体内容见下表
例:1(0000 0001)表示可开启大小写敏感,不可开启流式匹配;3(0000 0011)表示可开启大小写敏感,也可开启流式匹配

  • 位(低位到高位)- 描述
  • 1 - 大小写敏感
  • 2 - 流式匹配
1
MaxLengthinteger

匹配内容可输入的最大个数限制,根据 Type 取值不同,该参数取值如下:

  • 取值为 multi 时,表示可输入的最大个数限制。

  • 取值为 single 时,该参数为 1。

  • 取值为 none 时,该参数为 0。

50
Descriptionstring

控制台显示逻辑符。

等于多值之一
Regexpobject

正则表达式。

Patternstring

正则表达式。

^\S+$
ErrMsgstring

匹配不上正则表达式的错误信息。

字段不能为空

示例

正常返回示例

JSON格式

{
  "RequestId": "153ca2cd-3c01-44be-204c-64dbc6c88630",
  "Content": [
    {
      "DefenseScene": "custom_acl",
      "Fields": [
        {
          "ExtendField": "自定义Header",
          "MatchField": "Header",
          "LogicalSymbol": [
            {
              "Type": "multi",
              "Symbol": "match-one",
              "Tip": "可以输入多个,最多50个,按回车键确认",
              "Attributes": 1,
              "MaxLength": 50,
              "Description": "等于多值之一",
              "Regexp": {
                "Pattern": "^\\S+$",
                "ErrMsg": "字段不能为空"
              }
            }
          ]
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-21OpenAPI 返回结构发生变更查看变更详情