forked from docs/doc-exports
Li, Qiao
914011d51b
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>
186 lines
14 KiB
HTML
186 lines
14 KiB
HTML
<a name="waf_02_0067"></a><a name="waf_02_0067"></a>
|
|
|
|
<h1 class="topictitle1">Adding a False Alarm Masking Rule</h1>
|
|
<div id="body36819091"><div class="section" id="waf_02_0067__section37846565"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0067__p29556356">This API is used to add a false alarm masking rule.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0067__section5074769"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0067__ul45254630"><li id="waf_02_0067__li4638488">URI format<p id="waf_02_0067__p41746400"><a name="waf_02_0067__li4638488"></a><a name="li4638488"></a>POST /v1/{project_id}/waf/policy/{policy_id}/ignore</p>
|
|
</li><li id="waf_02_0067__li40173286">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0067__table26015259" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0067__row11776346"><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_0067__p14359950"><strong id="waf_02_0067__b19215190123816">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_0067__p22305295"><strong id="waf_02_0067__b1643918153819">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_0067__p61898436"><strong id="waf_02_0067__b18456193143811">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_0067__p47717397"><strong id="waf_02_0067__b29566515387">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0067__row39903980"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0067__p10996910">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_0067__p18334533">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_0067__p8702233">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_0067__p33792273">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0067__row35695006"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0067__p5614408">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_0067__p52113931">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_0067__p60478862">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_0067__p66949625">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0067__section45672928"><h4 class="sectiontitle">Request</h4><div class="p" id="waf_02_0067__p152088421874">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0067__table28978345" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0067__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_0067__p58016212"><strong id="waf_02_0067__b101746308388">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_0067__p1692722"><strong id="waf_02_0067__b3592131163820">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_0067__p2892797"><strong id="waf_02_0067__b142240343383">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_0067__p32989980"><strong id="waf_02_0067__b12581335133814">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0067__row54942712"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0067__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_0067__p37424900">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.2982701729827%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0067__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_0067__p60549731">Specifies a misreported URL excluding a domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0067__row8076672"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0067__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_0067__p42155511">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.2982701729827%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0067__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_0067__p26685393">Specifies the event ID.</p>
|
|
<p id="waf_02_0067__p167454859433">ID of a misreported event in <strong id="waf_02_0067__b16330640781">Events</strong> whose type is not <strong id="waf_02_0067__b193384406816">Custom</strong>. Click <strong id="waf_02_0067__b6704827144719">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_0067__section8403169"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0067__p12705737816">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0067__table55078859" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0067__row22625886"><th align="left" class="cellrowborder" valign="top" width="33.506649335066484%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0067__p20757491"><strong id="waf_02_0067__b1222213115395">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.697330266973296%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0067__p3635196"><strong id="waf_02_0067__b10994424392">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_0067__p26015458"><strong id="waf_02_0067__b415814543911">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0067__row32812531"><td class="cellrowborder" valign="top" width="33.506649335066484%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0067__p40569326">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.697330266973296%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0067__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_0067__p21596862">Specifies the ID of a false alarm masking rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0067__row60154037"><td class="cellrowborder" valign="top" width="33.506649335066484%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0067__p40638849">policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.697330266973296%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0067__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_0067__p7977575">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0067__row4689317"><td class="cellrowborder" valign="top" width="33.506649335066484%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0067__p44290396">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.697330266973296%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0067__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_0067__p6326519018715">Specifies a misreported URL excluding a domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0067__row470312574414"><td class="cellrowborder" valign="top" width="33.506649335066484%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0067__p15703157164110">event_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.697330266973296%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0067__p470425715413">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_0067__p107041575411">Specifies the event ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0067__row1526717534217"><td class="cellrowborder" valign="top" width="33.506649335066484%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0067__p162671059425">event_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.697330266973296%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0067__p62682512424">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_0067__p1326819514426">Specifies the event type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0067__row4077641"><td class="cellrowborder" valign="top" width="33.506649335066484%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0067__p61853493">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.697330266973296%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0067__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_0067__p12128762">Specifies the time when a false alarm masking rule is added.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0067__row67156410597"><td class="cellrowborder" valign="top" width="33.506649335066484%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0067__p164965752714">rule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.697330266973296%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0067__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_0067__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_0067__section12614079815"><h4 class="sectiontitle">Examples</h4><p id="waf_02_0067__p18942144944812">Rule ID <strong id="waf_02_0067__b16516545185317">100001</strong> is used as example.</p>
|
|
<ul id="waf_02_0067__ul56294718819"><li id="waf_02_0067__li36291870811">Request example<pre class="screen" id="waf_02_0067__screen16629774815">{
|
|
"path": "/a",
|
|
"event_id": "3737fb122f2140f39292f597ad3b7e9a"
|
|
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="waf_02_0067__ul16629107181"><li id="waf_02_0067__li11629187486">Response example<pre class="screen" id="waf_02_0067__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_0067__section8519663"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0067__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0067__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 4</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0067__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0067__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_0067__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_0067__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_0067__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_0067__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0067__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_0067__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_0067__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_0067__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0067__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>
|
|
|