doc-exports/docs/waf/api-ref/waf_02_0089.html
Li, Qiao 914011d51b waf_api_1109
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>
2022-11-16 15:31:27 +00:00

194 lines
14 KiB
HTML

<a name="waf_02_0089"></a><a name="waf_02_0089"></a>
<h1 class="topictitle1">Updating a False Alarm Masking Rule</h1>
<div id="body1557803953190"><div class="section" id="waf_02_0089__section13997563"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0089__p60145139">This API is used to update a false alarm masking rule.</p>
<p id="waf_02_0089__p3538649183115"></p>
</div>
<div class="section" id="waf_02_0089__section18853009"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0089__ul51077146"><li id="waf_02_0089__li57041136">URI format<p id="waf_02_0089__p43608182"><a name="waf_02_0089__li57041136"></a><a name="li57041136"></a>PUT /v1/{project_id}/waf/policy/{policy_id}/ignore/{ignore_id}</p>
</li><li id="waf_02_0089__li56929326">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0089__table42601887" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0089__row58492696"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="waf_02_0089__p40287960"><strong id="waf_02_0089__b19111123744">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="waf_02_0089__p42099345"><strong id="waf_02_0089__b124151324644">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="waf_02_0089__p54603754"><strong id="waf_02_0089__b1734619257414">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="waf_02_0089__p60827915">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0089__row28114077"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0089__p62647751">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0089__p41303090">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0089__p57216006">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0089__p3984873">Specifies the project ID.</p>
</td>
</tr>
<tr id="waf_02_0089__row35863865"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0089__p19291961">policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0089__p19144989">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0089__p7240270">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0089__p49590963">Specifies the policy ID.</p>
</td>
</tr>
<tr id="waf_02_0089__row1212015781017"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0089__p812119579109">ignore_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0089__p2012215710106">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0089__p131221457101018">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0089__p8122105771015">Specifies the ID of a false alarm masking rule.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="waf_02_0089__section45672928"><h4 class="sectiontitle">Request</h4><div class="p" id="waf_02_0089__p152088421874">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0089__table28978345" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0089__row42969978"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.1.2.5.1.1"><p id="waf_02_0089__p58016212"><strong id="waf_02_0089__b1551610436412">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.3.2.1.2.5.1.2"><p id="waf_02_0089__p1692722"><strong id="waf_02_0089__b1649734420416">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.2982701729827%" id="mcps1.3.3.2.1.2.5.1.3"><p id="waf_02_0089__p2892797"><strong id="waf_02_0089__b1434994511411">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.84601539846015%" id="mcps1.3.3.2.1.2.5.1.4"><p id="waf_02_0089__p32989980">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0089__row54942712"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0089__p21174648">path</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0089__p37424900">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.2982701729827%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0089__p11518085">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.84601539846015%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0089__p60549731">Specifies a misreported URL excluding a domain name.</p>
</td>
</tr>
<tr id="waf_02_0089__row8076672"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0089__p50230708">event_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0089__p42155511">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.2982701729827%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0089__p59153268">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.84601539846015%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0089__p26685393">Specifies the event ID.</p>
<p id="waf_02_0089__p167454859433">It is the ID of a misreported event in <strong id="waf_02_0089__b1252617551442">Events</strong> whose type is not <strong id="waf_02_0089__b125272551748">Custom</strong>. Click <strong id="waf_02_0089__b963911112519">Handle False Alarm</strong> in the row containing the attack event to obtain the event ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="waf_02_0089__section8403169"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0089__p12705737816">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0089__table55078859" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0089__row22625886"><th align="left" class="cellrowborder" valign="top" width="27.35726427357264%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0089__p20757491"><strong id="waf_02_0089__b14404106518">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32.84671532846715%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0089__p3635196"><strong id="waf_02_0089__b537810118515">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.2.1.2.4.1.3"><p id="waf_02_0089__p26015458">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0089__row32812531"><td class="cellrowborder" valign="top" width="27.35726427357264%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0089__p40569326">id</p>
</td>
<td class="cellrowborder" valign="top" width="32.84671532846715%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0089__p64889978">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0089__p21596862">Specifies the ID of a false alarm masking rule.</p>
</td>
</tr>
<tr id="waf_02_0089__row60154037"><td class="cellrowborder" valign="top" width="27.35726427357264%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0089__p40638849">policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="32.84671532846715%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0089__p3412506">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0089__p7977575">Specifies the policy ID.</p>
</td>
</tr>
<tr id="waf_02_0089__row4689317"><td class="cellrowborder" valign="top" width="27.35726427357264%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0089__p44290396">path</p>
</td>
<td class="cellrowborder" valign="top" width="32.84671532846715%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0089__p30752315">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0089__p6326519018715">Specifies a misreported URL excluding a domain name.</p>
</td>
</tr>
<tr id="waf_02_0089__row1597411435468"><td class="cellrowborder" valign="top" width="27.35726427357264%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0089__p10975194318465">event_id</p>
</td>
<td class="cellrowborder" valign="top" width="32.84671532846715%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0089__p11975154320465">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0089__p09751343204611">Specifies the event ID.</p>
</td>
</tr>
<tr id="waf_02_0089__row1992217476467"><td class="cellrowborder" valign="top" width="27.35726427357264%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0089__p1292254716461">event_type</p>
</td>
<td class="cellrowborder" valign="top" width="32.84671532846715%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0089__p159221747134617">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0089__p492294711463">Specifies the event type.</p>
</td>
</tr>
<tr id="waf_02_0089__row4077641"><td class="cellrowborder" valign="top" width="27.35726427357264%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0089__p61853493">timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="32.84671532846715%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0089__p44076997">Long</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0089__p12128762">Specifies the time when a false alarm masking rule is added.</p>
</td>
</tr>
<tr id="waf_02_0089__row67156410597"><td class="cellrowborder" valign="top" width="27.35726427357264%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0089__p164965752714">rule</p>
</td>
<td class="cellrowborder" valign="top" width="32.84671532846715%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0089__p4496177192720">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0089__p849657142719">Specifies the rule ID, which consists of six digits and cannot be empty.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="waf_02_0089__section12614079815"><h4 class="sectiontitle">Examples</h4><ul id="waf_02_0089__ul56294718819"><li id="waf_02_0089__li36291870811">Request example<pre class="screen" id="waf_02_0089__screen16629774815">{
"path": "/a",
"event_id": "3737fb122f2140f39292f597ad3b7e9a"
}</pre>
</li></ul>
<ul id="waf_02_0089__ul16629107181"><li id="waf_02_0089__li11629187486">Response example<pre class="screen" id="waf_02_0089__screen14629197987">{
"id": "6cdc116040d444f6b3e1bf1dd629f1d0",
"policy_id": "44d887434169475794b2717438f7fa78",
"path": "/a",
"event_id": "3737fb122f2140f39292f597ad3b7e9a",
"event_type": "xss",
"rule": "100001",
"timestamp": 1499817600
}</pre>
</li></ul>
</div>
<div class="section" id="waf_02_0089__section8519663"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0089__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0089__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 4</a> describes the normal status code returned by the API.
<div class="tablenoborder"><a name="waf_02_0089__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0089__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="waf_02_0089__waf_02_0012_r3d6e2f205c444705bdbb9daaac74e575"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.6.2.2.2.4.1.1"><p id="waf_02_0089__waf_02_0012_af3c4073076f24eca88d94e3fa1effdc6">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.41%" id="mcps1.3.6.2.2.2.4.1.2"><p id="waf_02_0089__waf_02_0012_en-us_topic_0144911667_p4531342288">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.589999999999996%" id="mcps1.3.6.2.2.2.4.1.3"><p id="waf_02_0089__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0089__waf_02_0012_rc7b2adc390904a1ba79e303017797786"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="waf_02_0089__waf_02_0012_a93f3895d44bb4226934cc626ac50e37b">200</p>
</td>
<td class="cellrowborder" valign="top" width="19.41%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="waf_02_0089__waf_02_0012_en-us_topic_0144911667_p7538425819">OK</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="waf_02_0089__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="waf_02_0089__waf_02_0012_en-us_topic_0144911667_p482819399522">For details about error status codes, see <a href="waf_02_0085.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="waf_02_0065.html">False Alarm Masking Rules</a></div>
</div>
</div>