{"base_path":"/","components":null,"consumes":"","definitions":{"Condition":{"properties":{"category":{"description":"字段类型,可选值有ip、url、params、cookie、header","type":"string"},"check_all_indexes_logic":{"description":"字段类型为url或ip时不存在check_all_indexes_logic字段,其它情况下(1:检查所有子字段,2:检查任意子字段,null:使用自定义子字段)","type":"integer"},"contents":{"description":"内容,数组长度限制为1,内容格式根据字段类型变化,例如,字段类型为ip时,contents内容格式需为ip地址或ip地址段;字段类型为url时,contents内容格式需为标准url格式;字段类型为params、cookie、header时,内容的格式不做限制","items":{"type":"string"},"type":"array"},"index":{"description":"字段类型为ip且子字段为客户端ip时,不存在index参数;子字段类型为X-Forwarded-For时,值为x-forwarded-for,字段类型为params、header、cookie并且子字段为自定义时,index的值为自定义子字段","type":"string"},"logic_operation":{"description":"匹配逻辑,匹配逻辑根据字段类型变化,字段类型为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:正则不匹配)","type":"string"}},"type":"object"},"IAM5ErrorDetails":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此信息0。","properties":{"error_code":{"description":"下游服务错误码","type":"string"},"error_msg":{"description":"下游服务报错信息","type":"string"}}},"IgnoreAdvanced":{"description":"若想忽略来源于某攻击事件下指定字段的攻击,可在“高级设置”里选择指定字段进行配置,配置完成后,WAF将不再拦截指定字段的攻击事件。当时,当不检测模块为所有检测模块时,不支持配置该高级配置。","properties":{"contents":{"description":"指定字段类型的子字段,默认值为“全部”","items":{"type":"string"},"type":"array"},"index":{"description":"字段类型,支持的字段类型有:Params、Cookie、Header、Body、Multipart。 \n - 当选择“Params”、“Cookie”或者“Header”字段时,可以配置“全部”或根据需求配置子字段 \n - 当选择“Body”或“Multipart”字段时,可以配置“全部”","type":"string"}}},"RestErrorResponse":{"properties":{"details":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。","items":{"$ref":"#/definitions/IAM5ErrorDetails"},"type":"array"},"encoded_authorization_message":{"description":"编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。","type":"string"},"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误信息","type":"string"}},"title":"RestErrorResponse","type":"object"},"ShowIgnoreRuleResponseBody":{"properties":{"advanced":{"$ref":"#/definitions/IgnoreAdvanced","description":"高级配置项"},"conditions":{"description":"条件","items":{"$ref":"#/definitions/Condition"},"type":"array"},"description":{"description":"规则描述","type":"string"},"domain":{"description":"防护域名或防护网站","items":{"type":"string"},"type":"array"},"id":{"description":"规则id","type":"string"},"mode":{"description":"版本号,0代表v1旧版本,1代表v2新版本;mode为0时,不存在conditions字段,存在url和url_logic字段;mode为1时,不存在url和url_logic字段,存在conditions字段","type":"integer"},"policyid":{"description":"策略id","type":"string"},"rule":{"description":"需要屏蔽的规则,可屏蔽一个或者多个,屏蔽多个时使用半角符;分隔 \n - 当需要屏蔽某一条内置规则时,该参数值为该内置规则id,可以在Web应用防火墙控制台的防护策略->策略名称->Web基础防护的高级设置->防护规则中查询;也可以在防护事件的事件详情中查询内置规则id \n - 当需要屏蔽web基础防护某一类规则时,该参数值为需要屏蔽的web基础防护某一类规则名。其中,xss:xss攻击;webshell:网站木马;vuln:其他类型攻击;sqli:sql注入攻击;robot:恶意爬虫;rfi:远程文件包含;lfi:本地文件包含;cmdi:命令注入攻击 \n - 当需要屏蔽Web基础防护模块,该参数值为:all \n - 当需要屏蔽规则为所有检测模块时,该参数值为:bypass","type":"string"},"status":{"description":"规则状态,0:关闭,1:开启","type":"integer"},"timestamp":{"description":"创建规则的时间戳","format":"int64","type":"integer"},"url":{"description":"误报规则屏蔽路径,仅在mode为0的状态下有该字段","type":"string"},"url_logic":{"description":"url匹配逻辑","type":"string"}}}},"description":null,"group_id":"29975c0bd7ce463ca70ad5c074e3974b","host":"waf.cn-north-4.myhuaweicloud.com","id":"6f0ccdf9403f4332adba6a1ee3a98847","info_version":"v1","method":"get","name":"ShowIgnoreRule","parameters":{},"paths":{"/v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id}":{"get":{"description":"查询全局白名单(原误报屏蔽)防护规则","operationId":"ShowIgnoreRule","parameters":[{"description":"用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"default":"application/json;charset=utf8","description":"内容类型","in":"header","name":"Content-Type","required":true,"type":"string"},{"default":"","description":"项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID","in":"path","name":"project_id","required":true,"type":"string"},{"description":"您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id","in":"query","name":"enterprise_project_id","required":false,"type":"string"},{"default":"","description":"防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id","in":"path","name":"policy_id","required":true,"type":"string"},{"default":"","description":"误报屏蔽规则id,您可以通过查询误报屏蔽规则列表(ListIgnoreRule)接口的响应体中的id字段获取误报屏蔽规则id","in":"path","name":"rule_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"请求成功","examples":{"application/json":{"advanced":{"contents":[],"index":"params"},"conditions":[{"category":"url","contents":["/test"],"logic_operation":"contain"}],"description":"","domain":[],"id":"16e81d9a9e0244359204d7f00326ee4f","mode":1,"policyid":"0681f69f94ac408e9688373e45a61fdb","rule":"webshell;vuln","status":1,"timestamp":1679106005786}},"schema":{"$ref":"#/definitions/ShowIgnoreRuleResponseBody"}},"400":{"description":"请求失败","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"token权限不足","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"服务器内部错误","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"查询全局白名单(原误报屏蔽)防护规则","tags":["策略规则管理"],"x-is-registered":"Y","x-request-examples-description-1":"查询项目id为project_id,防护策略id为policy_id,规则id为rule_id的全局白名单(原误报屏蔽)防护规则。","x-request-examples-url-1":"GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id}","x-support-international":true,"x-support-sdk":"Y"}}},"product_short":"WAF","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询全局白名单(原误报屏蔽)防护规则","tags":"策略规则管理","uri":null,"version":"2.0"}