# 更新全局白名单(原误报屏蔽)防护规则 - UpdateIgnoreRule
#### 功能介绍
更新全局白名单(原误报屏蔽)防护规则
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-waf/waf_02_0007.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-waf/waf_02_0119.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                        | 访问级别  | 资源类型（\*为必须） | 条件键                   | 别名                             | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | waf:falseAlarmMaskRule:put | Write | policy \*   | g:EnterpriseProjectId | waf:falseAlarmMaskRule:recount | -      |
     
  
 
#### URI
PUT /v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id}
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 项目ID，对应华为云控制台用户名-\>我的凭证-\>项目列表-\>项目ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                      |
| policy_id  | 是    | String | **参数解释：** 防护策略id，您可以通过调用查询防护策略列表（ListPolicy）获取策略id **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                   |
| rule_id    | 是    | String | **参数解释：** 误报屏蔽规则id，您可以通过查询误报屏蔽规则列表（ListIgnoreRule）接口的响应体中的id字段获取规则id **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
表2Query参数 
| 参数                    | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| 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                           |
   
表4请求Body参数 
| 参数          | 是否必选 | 参数类型                                                                           | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| domain      | 是    | Array of strings                                                               | 防护域名或防护网站，数组长度为0时，代表规则对全部域名或防护网站生效                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| conditions  | 是    | Array of [CreateCondition] objects | 条件列表                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| mode        | 是    | Integer                                                                        | 固定值为1,代表v2版本误报屏蔽规则，v1版本仅用于兼容旧版本，不支持创建                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| rule        | 是    | String                                                                         | **参数解释：** 需要屏蔽的规则 **约束限制：** 参数值根据"不检测模块"变化 **取值范围：** 不检测模块: - 所有模块: bypass   - Web基础防护模块按照规则类型划分: - ID: 内置规则id，通过ListWebBasicProtectionRules接口获取ID，多个id以分号;分隔，比如："000000;111111"   - 类别: 多个类型以分号;分隔，比如："xss;webshell" - xss：XSS攻击   - webshell：网站木马   - vuln：其他类型攻击   - sqli：SQL注入攻击   - robot：恶意爬虫   - rfi：远程文件包含   - lfi：本地文件包含   - cmdi：命令注入攻击      - 所有内置规则      - 非法请求: illegal    **默认取值：** 不涉及 |
| advanced    | 否    | [IgnoreAdvanced] object             | 高级配置项                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| description | 否    | String                                                                         | 屏蔽规则描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
   
 表5CreateCondition 
| 参数                      | 是否必选 | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| category                | 是    | String           | **参数解释：** 字段类型 **约束限制：** 不涉及 **取值范围：** - url: 路径   - custom_geoip: 客户端IP所属的地理位置   - robot: 已知特征爬虫   - user-agent: User Agent   - ip: IPv4   - ipv6: IPv6   - params: Params   - cookie: Cookie   - referer: Referer   - header: Header   - method: Method   - request_line: Request Line   - request: Request   - protocol: Protocol   - request_body: Request Body    **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| index                   | 否    | String           | **参数解释：** 子字段 **约束限制：** 随字段类型变化 **取值范围：** - custom_geoip: - v4：ipv4   - v6：ipv6   - any：ipv4或ipv6      - ip/ipv6: - null：客户端IP   - x-forwarded-for：请求header中X-Forwarded-For记录的IP   - $remote_addr：TCP连接IP   - $remote_sockaddr：3层源IP      - params/cookie/header： - check_all_indexes_logic为null： 可自定义子字段名称   - check_all_indexes_logic不为null：必须为null      - 其他字段类型：不支持，默认为null    **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| logic_operation         | 是    | String           | **参数解释：** 匹配逻辑 **约束限制：** 匹配逻辑根据字段类型变化 **取值范围：** - url/user-agent/referer: - contain_any: 包含任意一个   - not_contain_all: 不包含全部   - equal_any: 等于任意一个   - not_equal_all: 不等于全部   - prefix_any: 前缀匹配任意一个   - not_prefix_all: 前缀不匹配全部   - suffix_any: 后缀匹配任意一个   - not_suffix_all: 后缀不匹配全部   - contain: 包含   - not_contain: 不包含   - equal: 等于   - not_equal: 不等于   - prefix: 前缀匹配   - not_prefix: 前缀不匹配   - suffix: 后缀匹配   - not_suffix: 后缀不匹配   - len_equal: 长度等于   - len_not_equal: 长度不等于   - len_greater: 长度大于   - len_less: 长度小于   - len_greater_equal: 长度大于等于   - len_less_equal: 长度小于等于   - regular_match: 正则匹配   - regular_not_match: 正则不匹配      - custom_geoip: - belong: 属于   - not_belong: 不属于      - robot: - match: 匹配   - not_match: 不匹配      - ip/ipv6: - equal_any: 等于任意一个   - not_equal_all: 不等于全部   - equal: 等于   - not_equal: 不等于      - params/cookie/header: - contain_any: 包含任意一个   - not_contain_all: 不包含全部   - equal_any: 等于任意一个   - not_equal_all: 不等于全部   - prefix_any: 前缀匹配任意一个   - not_prefix_all: 前缀不匹配全部   - suffix_any: 后缀匹配任意一个   - not_suffix_all: 后缀不匹配全部   - contain: 包含   - not_contain: 不包含   - equal: 等于   - not_equal: 不等于   - prefix: 前缀匹配   - not_prefix: 前缀不匹配   - suffix: 后缀匹配   - not_suffix: 后缀不匹配   - len_equal: 长度等于   - len_not_equal: 长度不等于   - len_greater: 长度大于   - len_less: 长度小于   - len_greater_equal: 长度大于等于   - len_less_equal: 长度小于等于   - num_equal: 数字等于   - num_not_equal: 数字不等于   - num_greater: 数字大于   - num_less: 数字小于   - exist: 存在   - not_exist: 不存在   - regular_match: 正则匹配   - regular_not_match: 正则不匹配      - method/protocol: - equal: 等于   - not_equal: 不等于      - request_line: - len_equal: 长度等于   - len_not_equal: 长度不等于   - len_greater: 长度大于   - len_less: 长度小于   - len_greater_equal: 长度大于等于   - len_less_equal: 长度小于等于      - request: - len_equal: 长度等于   - len_not_equal: 长度不等于   - len_greater: 长度大于   - len_less: 长度小于   - len_greater_equal: 长度大于等于   - len_less_equal: 长度小于等于   - regular_match: 正则匹配   - regular_not_match: 正则不匹配      - request_body: - contain: 包含   - contain_any: 包含任意一个   - not_contain: 不包含   - not_contain_all: 不包含全部   - regular_match: 正则匹配   - regular_not_match: 正则不匹配       **默认取值：** 不涉及 |
| contents                | 否    | Array of strings | **参数解释：** 条件列表逻辑匹配内容 **约束限制：** 当logic_operation参数不以any或者all结尾时，需要传该参数 **取值范围：** 匹配内容字符串长度范围：\[1, 4096\] 内容格式根据参数category和logic_operation变化： - logic_operation为数值比较类型：纯数字   - url: URL格式；仅支持单个匹配内容   - custom_geoip: 客户端IP所属国家或省份，多个位置以\|分隔，比如："BJ\|SH"   - robot: 已知特征爬虫列表，可选择多个 - crawler_engine：搜索引擎   - crawler_scanner：扫描器   - crawler_script：脚本工具   - crawler_other：其他爬虫      - ip: IPv4   - ipv6: IPv6   - referer: 例如：http://test.com   - params：不包含\&   - user-agent/cookie/header/request_body: 无限制   - method: HTTP协议支持的method，字母大写   - protocol: - http   - https       **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| check_all_indexes_logic | 否    | Integer          | **参数解释：** 需要检查所有子字段或检查任意子字段时传此参数 **约束限制：** 仅当category为params/cookie/header时支持 **取值范围：** - 1：所有子字段   - 2：任意子字段    **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| value_list_id           | 否    | String           | **参数解释：** 引用表ID **约束限制：** 当logic_operation参数以any或者all结尾时，需要传该参数；引用表类型要与category类型保持一致 **取值范围：** 通过ListValueList接口获取引用表ID **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
   
 表6IgnoreAdvanced 
| 参数       | 是否必选 | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| index    | 否    | String           | 字段类型，支持的字段类型有：params、cookie、header、body、multipart。 - 当选择"params"、"cookie"或者"header"字段时，可以配置"全部"或根据需求配置子字段   - 当选择"body"或"multipart"字段时，可以配置"全部"    |
| contents | 否    | Array of strings | 指定字段类型的子字段，默认值为"全部"                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
   
#### 响应参数
**状态码：200**
表7响应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                                                             | 规则的命中次数                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
   
 表8Condition 
| 参数                      | 参数类型             | 描述                                                                                                                                                                                                                                                  |
|:---|:---|:---|
| 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的值为自定义子字段                                                                                                                           |
   
 表9IgnoreAdvanced 
| 参数       | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| index    | String           | 字段类型，支持的字段类型有：params、cookie、header、body、multipart。 - 当选择"params"、"cookie"或者"header"字段时，可以配置"全部"或根据需求配置子字段   - 当选择"body"或"multipart"字段时，可以配置"全部"    |
| contents | Array of strings | 指定字段类型的子字段，默认值为"全部"                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
   
**状态码：400**
表10响应Body参数 
| 参数                            | 参数类型                                                                              | 描述                                                                                                 |
|:---|:---|:---|
| error_code                    | String                                                                            | 错误码                                                                                                |
| error_msg                     | String                                                                            | 错误信息                                                                                               |
| encoded_authorization_message | String                                                                            | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details                       | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。                                                                    |
   
 表11IAM5ErrorDetails 
| 参数         | 参数类型   | 描述       |
|:---|:---|:---|
| error_code | String | 下游服务错误码  |
| error_msg  | String | 下游服务报错信息 |
   
**状态码：401**
表12响应Body参数 
| 参数                            | 参数类型                                                                                | 描述                                                                                                 |
|:---|:---|:---|
| error_code                    | String                                                                              | 错误码                                                                                                |
| error_msg                     | String                                                                              | 错误信息                                                                                               |
| encoded_authorization_message | String                                                                              | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details                       | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。                                                                    |
   
 表13IAM5ErrorDetails 
| 参数         | 参数类型   | 描述       |
|:---|:---|:---|
| error_code | String | 下游服务错误码  |
| error_msg  | String | 下游服务报错信息 |
   
**状态码：500**
表14响应Body参数 
| 参数                            | 参数类型                                                                                | 描述                                                                                                 |
|:---|:---|:---|
| error_code                    | String                                                                              | 错误码                                                                                                |
| error_msg                     | String                                                                              | 错误信息                                                                                               |
| encoded_authorization_message | String                                                                              | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details                       | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。                                                                    |
   
 表15IAM5ErrorDetails 
| 参数         | 参数类型   | 描述       |
|:---|:---|:---|
| error_code | String | 下游服务错误码  |
| error_msg  | String | 下游服务报错信息 |
   
#### 请求示例
更新项目id为project_id，防护策略id为policy_id，规则id为rule_id的全局白名单(原误报屏蔽)防护规则。修改防护条件为url包含"/test"，需要屏蔽的规则为网站木马和其他类型攻击，配置高级配置项为全部参数。
```
PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id}
{
  "domain" : [ ],
  "mode" : 1,
  "description" : "",
  "conditions" : [ {
    "category" : "url",
    "logic_operation" : "contain",
    "index" : null,
    "contents" : [ "/test" ]
  } ],
  "rule" : "webshell;vuln",
  "advanced" : {
    "index" : "params",
    "contents" : [ ]
  }
}
```
#### 响应示例
**状态码：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" : [ ]
  },
  "update_time" : 1679106005786,
  "clear_time" : 1679106005786,
  "hit_num" : 0
}
```
#### SDK代码示例
SDK代码示例如下。
- [Java]
  更新项目id为project_id，防护策略id为policy_id，规则id为rule_id的全局白名单(原误报屏蔽)防护规则。修改防护条件为url包含"/test"，需要屏蔽的规则为网站木马和其他类型攻击，配置高级配置项为全部参数。
  ```
  package com.huaweicloud.sdk.test;
  import com.huaweicloud.sdk.core.auth.ICredential;
  import com.huaweicloud.sdk.core.auth.BasicCredentials;
  import com.huaweicloud.sdk.core.exception.ConnectionException;
  import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
  import com.huaweicloud.sdk.core.exception.ServiceResponseException;
  import com.huaweicloud.sdk.waf.v1.region.WafRegion;
  import com.huaweicloud.sdk.waf.v1.*;
  import com.huaweicloud.sdk.waf.v1.model.*;
  import java.util.List;
  import java.util.ArrayList;
  public class UpdateIgnoreRuleSolution {
      public static void main(String[] args) {
          // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
          // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
          String ak = System.getenv("CLOUD_SDK_AK");
          String sk = System.getenv("CLOUD_SDK_SK");
          String projectId = "{project_id}";
          ICredential auth = new BasicCredentials()
                  .withProjectId(projectId)
                  .withAk(ak)
                  .withSk(sk);
          WafClient client = WafClient.newBuilder()
                  .withCredential(auth)
                  .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                  .build();
          UpdateIgnoreRuleRequest request = new UpdateIgnoreRuleRequest();
          request.withPolicyId("{policy_id}");
          request.withRuleId("{rule_id}");
          UpdateIgnoreRuleRequestBody body = new UpdateIgnoreRuleRequestBody();
          IgnoreAdvanced advancedbody = new IgnoreAdvanced();
          advancedbody.withIndex("params");
          List<String> listConditionsContents = new ArrayList<>();
          listConditionsContents.add("/test");
          List<CreateCondition> listbodyConditions = new ArrayList<>();
          listbodyConditions.add(
              new CreateCondition()
                  .withCategory(CreateCondition.CategoryEnum.fromValue("url"))
                  .withLogicOperation(CreateCondition.LogicOperationEnum.fromValue("contain"))
                  .withContents(listConditionsContents)
          );
          body.withDescription("");
          body.withAdvanced(advancedbody);
          body.withRule("webshell;vuln");
          body.withMode(1);
          body.withConditions(listbodyConditions);
          request.withBody(body);
          try {
              UpdateIgnoreRuleResponse response = client.updateIgnoreRule(request);
              System.out.println(response.toString());
          } catch (ConnectionException e) {
              e.printStackTrace();
          } catch (RequestTimeoutException e) {
              e.printStackTrace();
          } catch (ServiceResponseException e) {
              e.printStackTrace();
              System.out.println(e.getHttpStatusCode());
              System.out.println(e.getRequestId());
              System.out.println(e.getErrorCode());
              System.out.println(e.getErrorMsg());
          }
      }
  }
  ```
- [Python]
  更新项目id为project_id，防护策略id为policy_id，规则id为rule_id的全局白名单(原误报屏蔽)防护规则。修改防护条件为url包含"/test"，需要屏蔽的规则为网站木马和其他类型攻击，配置高级配置项为全部参数。
  ```
  # coding: utf-8
  import os
  from huaweicloudsdkcore.auth.credentials import BasicCredentials
  from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
  from huaweicloudsdkcore.exceptions import exceptions
  from huaweicloudsdkwaf.v1 import *
  if __name__ == "__main__":
      # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak = os.environ["CLOUD_SDK_AK"]
      sk = os.environ["CLOUD_SDK_SK"]
      projectId = "{project_id}"
      credentials = BasicCredentials(ak, sk, projectId)
      client = WafClient.new_builder() \
          .with_credentials(credentials) \
          .with_region(WafRegion.value_of("<YOUR REGION>")) \
          .build()
      try:
          request = UpdateIgnoreRuleRequest()
          request.policy_id = "{policy_id}"
          request.rule_id = "{rule_id}"
          advancedbody = IgnoreAdvanced(
              index="params"
          )
          listContentsConditions = [
              "/test"
          ]
          listConditionsbody = [
              CreateCondition(
                  category="url",
                  logic_operation="contain",
                  contents=listContentsConditions
              )
          ]
          request.body = UpdateIgnoreRuleRequestBody(
              description="",
              advanced=advancedbody,
              rule="webshell;vuln",
              mode=1,
              conditions=listConditionsbody
          )
          response = client.update_ignore_rule(request)
          print(response)
      except exceptions.ClientRequestException as e:
          print(e.status_code)
          print(e.request_id)
          print(e.error_code)
          print(e.error_msg)
  ```
- [Go]
  更新项目id为project_id，防护策略id为policy_id，规则id为rule_id的全局白名单(原误报屏蔽)防护规则。修改防护条件为url包含"/test"，需要屏蔽的规则为网站木马和其他类型攻击，配置高级配置项为全部参数。
  ```
  package main
  import (
  "fmt"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
      waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
      region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region"
  )
  func main() {
      // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak := os.Getenv("CLOUD_SDK_AK")
      sk := os.Getenv("CLOUD_SDK_SK")
      projectId := "{project_id}"
      auth, err := basic.NewCredentialsBuilder().
          WithAk(ak).
          WithSk(sk).
          WithProjectId(projectId).
          SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      hcClient, err := waf.WafClientBuilder().
           WithRegion(region.ValueOf("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := waf.NewWafClient(hcClient)
      request := &model.UpdateIgnoreRuleRequest{}
  request.PolicyId = "{policy_id}"
  request.RuleId = "{rule_id}"
  indexAdvanced:= "params"
  advancedbody := &model.IgnoreAdvanced{
  Index: &indexAdvanced,
  }
  var listContentsConditions = []string{
          "/test",
      }
  var listConditionsbody = []model.CreateCondition{
          {
              Category: model.GetCreateConditionCategoryEnum().URL,
              LogicOperation: model.GetCreateConditionLogicOperationEnum().CONTAIN,
              Contents: &listContentsConditions,
          },
      }
  descriptionUpdateIgnoreRuleRequestBody:= ""
  request.Body = &model.UpdateIgnoreRuleRequestBody{
  Description: &descriptionUpdateIgnoreRuleRequestBody,
  Advanced: advancedbody,
  Rule: "webshell;vuln",
  Mode: int32(1),
  Conditions: listConditionsbody,
  }
  response, err := client.UpdateIgnoreRule(request)
  if err == nil {
          fmt.Printf("%+v\n", response)
      } else {
          fmt.Println(err)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WAF/sdk?api=UpdateIgnoreRule)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述        |
|:---|:---|
| 200 | 请求成功      |
| 400 | 请求失败      |
| 401 | token权限不足 |
| 500 | 服务器内部错误   |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-waf/ErrorCode.html)。
