GetWafFilter - 获取WAF匹配引擎信息_边缘安全加速(ESA)-阿里云帮助中心

获取指定站点在特定WAF阶段的匹配引擎信息，这些信息定义了WAF如何检测和处理不同类型的网络请求。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
esa:GetWafFilter	get	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	无	无

请求参数

名称	类型	必填	描述	示例值
SiteId	long	否	站点 ID，可通过调用 ListSites 接口获取。	1
Phase	string	否	WAF 阶段，指定要查询的匹配引擎信息所处的 WAF 阶段。	http_bot
Target	string	否	取值目标，定义匹配引擎的应用目标。	characteristics
Type	string	否	规则类型。	http_custom_cc

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	36af3fcc-43d0-441c-86b1-428951dc8225
Filter	object	返回的匹配引擎配置信息。
Phase	string	WAF 处理请求的阶段。	http_bot
Target	string	匹配引擎取值目标。	characteristics
Type	string	规则类型。	http_custom_cc
Fields	array<object>	描述匹配对象及其相关属性的列表。
field	object	匹配对象相关属性
Label	string	用于展示的匹配对象的标签。	Header
Key	string	用于系统内部的匹配对象的参数。	http.request.headers
Sub	boolean	指示匹配对象是否应该包含子字段。	true
SubTip	string	提供给用户的关于如何输入子字段的提示。	e.g. Content-Type
Selector	object	选择器对象，定义如何选择匹配对象。
Kind	string	选择器种类，如用于选择数据项还是其他。	data
Data	array<object>	选择器种类为 data 时的可选数据列表。
Data	object	选择器种类为 data 时的可选数据。
Label	string	可选数据的展示标签。	China
Value	string	可选数据的参数值。	CN
Logics	array<object>	逻辑符属性列表，定义匹配时使用的逻辑条件。
Logic	object	匹配对象适用的逻辑符属性。
Symbol	string	用于系统内部的匹配符的参数。	eq
Operator	string	用于展示的匹配符的标签。	Does not equal
Negative	boolean	指示是否对匹配结果取反。
Type	string	值的类型，例如： integer：整型 integer_slice：整型数组 string：字符串型 string_slice：字符串型数组	string
Kind	string	值输入框类型，例如： select:single：单选输入框 select:multi：多选输入框 input:single：单输入框 input:multi：多输入框	input:single
Attributes	integer	可设置的属性，例如是否大小写敏感。	1
Tip	string	输入提示，帮助用户提供规则所需的合法值。	e.g. image/jpeg
Validator	object	验证器对象，用于定义值的验证规则。
Length	WafQuotaInteger	值的长度限制。
Pattern	string	值的正则表达式模式，用于字符串验证。	^example$
Range	WafQuotaInteger	值的数值范围，用于数字验证。
ErrMsg	string	验证不通过时的错误信息。	Enter a valid expression

示例

正常返回示例

JSON格式

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Filter": {
    "Phase": "http_bot",
    "Target": "characteristics",
    "Type": "http_custom_cc",
    "Fields": [
      {
        "Label": "Header",
        "Key": "http.request.headers",
        "Sub": true,
        "SubTip": "e.g. Content-Type",
        "Selector": {
          "Kind": "data",
          "Data": [
            {
              "Label": "China",
              "Value": "CN"
            }
          ]
        },
        "Logics": [
          {
            "Symbol": "eq",
            "Operator": "Does not equal",
            "Negative": true,
            "Type": "string",
            "Kind": "input:single",
            "Attributes": 1,
            "Tip": "e.g. image/jpeg",
            "Validator": {
              "Length": {
                "Equal": 0,
                "GreaterThan": 0,
                "GreaterThanOrEqual": 0,
                "LessThan": 0,
                "LessThanOrEqual": 0
              },
              "Pattern": "^example$",
              "Range": {
                "Equal": 0,
                "GreaterThan": 0,
                "GreaterThanOrEqual": 0,
                "LessThan": 0,
                "LessThanOrEqual": 0
              },
              "ErrMsg": "Enter a valid expression"
            }
          }
        ]
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is invalid.	输入参数规范校验失败。
400	InternalException	Failed to call the service. Try again later or contact technical support.	调用服务失败，请稍后重试或联系客服咨询详情。

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

变更历史

变更时间	变更内容概要	操作
2024-09-25	OpenAPI 错误码发生变更	查看变更详情
2024-09-18	OpenAPI 错误码发生变更	查看变更详情