全局白名单(原误报屏蔽)防护规则的命中次数清零 - UpdateIgnoreRuleHitNum

功能介绍

全局白名单(原误报屏蔽)防护规则的命中次数清零

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id}/recount

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，对应华为云控制台用户名->我的凭证->项目列表->项目ID 约束限制：不涉及取值范围：不涉及默认取值：不涉及
policy_id	是	String	参数解释：防护策略id，您可以通过调用查询防护策略列表（ListPolicy）获取策略id 约束限制：不涉及取值范围：不涉及默认取值：不涉及
rule_id	是	String	参数解释：误报屏蔽规则id，您可以通过查询误报屏蔽规则列表（ListIgnoreRule）接口的响应体中的id字段获取规则id 约束限制：不涉及取值范围：不涉及默认取值：不涉及

表2 Query参数
参数	是否必选	参数类型	描述
enterprise_project_id	否	String	参数解释：您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。约束限制：不涉及取值范围： 0：代表default企业项目 all_granted_eps：代表所有企业项目其它企业项目ID：长度为36个字符默认取值： 0

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。约束限制：不涉及取值范围：不涉及默认取值：不涉及
Content-Type	是	String	参数解释：内容类型约束限制：不涉及取值范围：不涉及默认取值： application/json;charset=utf8

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
id	String	规则id
policyid	String	策略id
timestamp	Long	创建规则的时间戳
description	String	规则描述
status	Integer	参数解释：规则状态标识，用于指定规则的启用或关闭状态约束限制：不涉及取值范围： 0：关闭 1：开启默认取值：不涉及
url	String	误报规则屏蔽路径，仅在mode为0的状态下有该字段
rule	String	被屏蔽检测的规则类型或规则ID
mode	Integer	版本号，0代表v1旧版本，1代表v2新版本；mode为0时，不存在conditions字段，存在url和url_logic字段；mode为1时，不存在url和url_logic字段，存在conditions字段
url_logic	String	url匹配逻辑
conditions	Array of Condition objects	条件
advanced	IgnoreAdvanced object	高级配置项
domain	Array of strings	防护域名或防护网站
update_time	Long	规则的最后更新时间
clear_time	Long	命中次数手动清零时间
hit_num	Integer	规则的命中次数

表5 Condition
参数	参数类型	描述
category	String	字段类型，可选值有ip、url、params、cookie、header
contents	Array of strings	内容,数组长度限制为1，内容格式根据字段类型变化，例如，字段类型为ip时，contents内容格式需为ip地址或ip地址段；字段类型为url时，contents内容格式需为标准url格式；字段类型为params、cookie、header时，内容的格式不做限制
logic_operation	String	匹配逻辑，匹配逻辑根据字段类型变化，字段类型为ip时，匹配逻辑支持（equal：等于，not_equal：不等于），字段类型为url、header、params、cookie时，匹配逻辑支持（equal：等于，not_equal：不等于，contain：包含，not_contain：不包含，prefix：前缀为，not_prefix：前缀不为，suffix：后缀为，not_suffix：后缀不为，regular_match：正则匹配，regular_not_match：正则不匹配）
check_all_indexes_logic	Integer	字段类型为url或ip时不存在check_all_indexes_logic字段，其它情况下（1：检查所有子字段，2：检查任意子字段，null：使用自定义子字段）
index	String	字段类型为ip且子字段为客户端ip时，不存在index参数；子字段类型为X-Forwarded-For时，值为x-forwarded-for，字段类型为params、header、cookie并且子字段为自定义时，index的值为自定义子字段

表6 IgnoreAdvanced
参数	参数类型	描述
index	String	字段类型，支持的字段类型有：Params、Cookie、Header、Body、Multipart。当选择“Params”、“Cookie”或者“Header”字段时，可以配置“全部”或根据需求配置子字段当选择“Body”或“Multipart”字段时，可以配置“全部”
contents	Array of strings	指定字段类型的子字段，默认值为“全部”

状态码：400

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
encoded_authorization_message	String	编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。
details	Array of IAM5ErrorDetails objects	调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

表8 IAM5ErrorDetails
参数	参数类型	描述
error_code	String	下游服务错误码
error_msg	String	下游服务报错信息

状态码：401

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
encoded_authorization_message	String	编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。
details	Array of IAM5ErrorDetails objects	调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

**表10** IAM5ErrorDetails
参数	参数类型	描述
error_code	String	下游服务错误码
error_msg	String	下游服务报错信息

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
encoded_authorization_message	String	编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。
details	Array of IAM5ErrorDetails objects	调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

**表12** IAM5ErrorDetails
参数	参数类型	描述
error_code	String	下游服务错误码
error_msg	String	下游服务报错信息

请求示例

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id}

响应示例

状态码：200

请求成功

{
  "id" : "16e81d9a9e0244359204d7f00326ee4f",
  "policyid" : "0681f69f94ac408e9688373e45a61fdb",
  "timestamp" : 1679106005786,
  "description" : "",
  "status" : 1,
  "rule" : "webshell;vuln",
  "mode" : 1,
  "conditions" : [ {
    "category" : "url",
    "contents" : [ "/test" ],
    "logic_operation" : "contain"
  } ],
  "domain" : [ ],
  "advanced" : {
    "index" : "params",
    "contents" : [ ]
  }
}