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>
213 lines
16 KiB
HTML
213 lines
16 KiB
HTML
<a name="waf_02_0066"></a><a name="waf_02_0066"></a>
|
|
|
|
<h1 class="topictitle1">Querying False Alarm Masking Rules</h1>
|
|
<div id="body43028647"><div class="section" id="waf_02_0066__section2094778"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0066__p62768419">This API is used to query all false alarm masking rules in a policy.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0066__section18853009"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0066__ul51077146"><li id="waf_02_0066__li57041136">URI format<p id="waf_02_0066__p43608182"><a name="waf_02_0066__li57041136"></a><a name="li57041136"></a>GET /v1/{project_id}/waf/policy/{policy_id}/ignore?path={path}&offset={offset}&limit={limit}</p>
|
|
</li><li id="waf_02_0066__li56929326">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0066__table42601887" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0066__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_0066__p40287960"><strong id="waf_02_0066__b5785182114327">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_0066__p42099345"><strong id="waf_02_0066__b19808946163216">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_0066__p54603754"><strong id="waf_02_0066__b9113348153212">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_0066__p60827915"><strong id="waf_02_0066__b3474184973216">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0066__row28114077"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0066__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_0066__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_0066__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_0066__p3984873">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0066__row35863865"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0066__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_0066__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_0066__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_0066__p49590963">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0066__row1212015781017"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0066__p812119579109">path</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_0066__p2012215710106">No</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_0066__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_0066__p8122105771015">Specifies the misreported URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0066__row43665484"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0066__p47243355">offset</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_0066__p1506579">No</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_0066__p54924059">Long</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_0066__p21617533">Specifies the number of returned pages. Its value ranges from <strong id="waf_02_0066__b9433145510342">0</strong> to <strong id="waf_02_0066__b124331255123413">65535</strong>. The default value is <strong id="waf_02_0066__b1243465511344">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0066__row42756216"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0066__p875914720329">limit</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_0066__p8484949">No</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_0066__p16192254">Long</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_0066__p25357967">Specifies the maximum number of records displayed on each page. Its value ranges from <strong id="waf_02_0066__b1826619571342">0</strong> to <strong id="waf_02_0066__b1826645714341">50</strong>. The default value is <strong id="waf_02_0066__b42661957103416">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0066__section35459357"><h4 class="sectiontitle">Request</h4><p id="waf_02_0066__p17628501869">Request parameters</p>
|
|
<p class="msonormal" id="waf_02_0066__p4049870">None</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0066__section50698759"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0066__p1246519595614">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0066__table63197648" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0066__row49462140"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0066__p47010409"><strong id="waf_02_0066__b1063472920333">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.117288271172878%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0066__p49746803"><strong id="waf_02_0066__b43971731123318">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_0066__p2959233"><strong id="waf_02_0066__b338463253320">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0066__row26633101"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0066__p9797597">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0066__p55407910">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0066__p58855695">Specifies the total number of policies.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0066__row59939207"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0066__p23237571">items</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0066__p3195124"><a href="#waf_02_0066__table16394183011019">Table 3</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0066__p57478530">Specifies the false alarm masking rule objects.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0066__table16394183011019"></a><a name="table16394183011019"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0066__table16394183011019" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="waf_02_0066__b13335182015341">items</strong></caption><thead align="left"><tr id="waf_02_0066__row939613301015"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0066__p039873016013"><strong id="waf_02_0066__b173931822155314">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.117288271172878%" id="mcps1.3.4.3.2.4.1.2"><p id="waf_02_0066__p183997301406"><strong id="waf_02_0066__b987036480">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.3.2.4.1.3"><p id="waf_02_0066__p839973013010"><strong id="waf_02_0066__b13111162515310">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0066__row71355371705"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0066__p1031011361902">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0066__p1631217361200">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0066__p12313536306">Specifies the ID of a false alarm masking rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0066__row21351837608"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0066__p43141936203">policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0066__p13316436805">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0066__p183181836204">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0066__row613319371801"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0066__p8320136807">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0066__p93202036804">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0066__p1532173610010">Specifies a misreported URL excluding a domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0066__row73641132163610"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0066__p193651632203614">event_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0066__p1836593273612">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0066__p113654323369">Specifies the event ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0066__row3844271371"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0066__p88441673372">event_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0066__p198441872374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0066__p5844107103719">Specifies the event type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0066__row201327371306"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0066__p6322133618019">rule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0066__p632311361307">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0066__p143255361501">Specifies the rule ID, which consists of six digits and cannot be empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0066__row9131113720015"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0066__p173278362004">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0066__p1329173611017">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0066__p1332911361107">Specifies the time when a false alarm masking rule is added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0066__section586416610719"><h4 class="sectiontitle">Example</h4><p id="waf_02_0066__p184591510484"><strong id="waf_02_0066__b4571153014532">total</strong> with a value of <strong id="waf_02_0066__b457293075312">2</strong> is used as an example.</p>
|
|
<div class="p" id="waf_02_0066__p1187446777">Response example<pre class="screen" id="waf_02_0066__screen68741862712">{
|
|
"total": 2,
|
|
"items": [{
|
|
"id": "3a9b5c0f96784ec8abd8ba61a98064ef",
|
|
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
|
|
"event_id": "02d3ac3cd99f440daf8d38e03cf0e2a6",
|
|
"event_type": "xss",
|
|
"rule": "100001",
|
|
"timestamp": 1499817600,
|
|
"path": "/a"
|
|
}, {
|
|
"id": "44d887434169475794b2717438f7fa78",
|
|
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
|
|
"event_id": "f8c74b656a9d4d329dbcefe0969cc427",
|
|
"event_type": "sqli",
|
|
"rule": "100002",
|
|
"timestamp": 1499817600,
|
|
"path": "/a"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0066__section53635648"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0066__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0066__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 4</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0066__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0066__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_0066__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_0066__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_0066__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_0066__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0066__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_0066__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_0066__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_0066__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0066__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>
|
|
|