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>
320 lines
27 KiB
HTML
320 lines
27 KiB
HTML
<a name="waf_02_0031"></a><a name="waf_02_0031"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Policy</h1>
|
|
<div id="body51863327"><div class="section" id="waf_02_0031__section15319872"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0031__p40179974">This API is used to query details about a policy.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0031__section3661125"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0031__ul33352490"><li id="waf_02_0031__li31736958">URI format<p id="waf_02_0031__p17197170"><a name="waf_02_0031__li31736958"></a><a name="li31736958"></a>GET /v1/{project_id}/waf/policy/{policy_id}</p>
|
|
</li><li id="waf_02_0031__li20556807">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0031__table50793543" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0031__row57499042"><th align="left" class="cellrowborder" valign="top" width="30.930000000000003%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="waf_02_0031__p26910830"><strong id="waf_02_0031__b167314917478">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.62%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="waf_02_0031__p32293618"><strong id="waf_02_0031__b10590161516460">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.430000000000001%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="waf_02_0031__p65646295"><strong id="waf_02_0031__b1864101284716">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.02%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="waf_02_0031__p15749701"><strong id="waf_02_0031__b3626141224714">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0031__row657379"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0031__p53247705">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0031__p18096848">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.430000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0031__p56558575">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0031__p17841887">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row26359261"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0031__p54725385">policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0031__p3571161">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.430000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0031__p20828597">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0031__p9394822">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0031__section32950126"><h4 class="sectiontitle">Request</h4><p id="waf_02_0031__p16189183316406">Request parameters</p>
|
|
<p class="msonormal" id="waf_02_0031__p22783156">None</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0031__section28115686"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0031__p1784964344016">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0031__table28850501" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0031__row44286268"><th align="left" class="cellrowborder" valign="top" width="24.3975602439756%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0031__p30417949"><strong id="waf_02_0031__b938353804716">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="35.80641935806419%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0031__p47934770"><strong id="waf_02_0031__b1486203914474">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.4.2.1.2.4.1.3"><p id="waf_02_0031__p57511139"><strong id="waf_02_0031__b55551739114716">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0031__row191871841133512"><td class="cellrowborder" valign="top" width="24.3975602439756%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0031__p1718764153519">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.80641935806419%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0031__p21871641133513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0031__p2187541103515">Specifies the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row11851038203520"><td class="cellrowborder" valign="top" width="24.3975602439756%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0031__p151851738183511">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.80641935806419%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0031__p12185193812359">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0031__p6185203816357">Specifies the policy name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row47838210"><td class="cellrowborder" valign="top" width="24.3975602439756%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0031__p49689834">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.80641935806419%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0031__p65453602"><a href="#waf_02_0031__table1231716412312">Table 3</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0031__p141522">Specifies the protective action after a rule is matched.</p>
|
|
<ul id="waf_02_0031__ul796714441001"><li id="waf_02_0031__li836931317112"><span class="parmvalue" id="waf_02_0031__parmvalue1312794717267"><b>block</b></span>: block and log detected attacks.</li><li id="waf_02_0031__li1967844901"><span class="parmvalue" id="waf_02_0031__parmvalue919319241583"><b>log</b></span>: only log detected attacks.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row12946355"><td class="cellrowborder" valign="top" width="24.3975602439756%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0031__p42021858">options</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.80641935806419%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0031__p48327333"><a href="#waf_02_0031__table1272813819259">Table 4</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0031__p22199909">Specifies the protection switches.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row50045227"><td class="cellrowborder" valign="top" width="24.3975602439756%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0031__p27131597">level</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.80641935806419%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0031__p50175772">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0031__p8528528245">Specifies the protection level.</p>
|
|
<ul id="waf_02_0031__ul14533143918414"><li id="waf_02_0031__li1653519392418"><span class="parmvalue" id="waf_02_0031__parmvalue184661522103015"><b>1</b></span>: low</li><li id="waf_02_0031__li155352391947"><span class="parmvalue" id="waf_02_0031__parmvalue7311102603010"><b>2</b></span>: medium</li><li id="waf_02_0031__li6535183919419"><span class="parmvalue" id="waf_02_0031__parmvalue8927429103012"><b>3</b></span>: high</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row3807228"><td class="cellrowborder" valign="top" width="24.3975602439756%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0031__p39950041">full_detection</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.80641935806419%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0031__p14727870">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0031__p68421843104420">Specifies the detection mode in Precise Protection.</p>
|
|
<ul id="waf_02_0031__ul02880554511"><li id="waf_02_0031__waf_02_0029_li4804353104611"><strong id="waf_02_0031__waf_02_0029_b1755019491619">true</strong>: full detection. Full detection finishes all threat detections before blocking requests that meet Precise Protection specified conditions.</li><li id="waf_02_0031__waf_02_0029_li318133918612"><strong id="waf_02_0031__waf_02_0029_b17686122792016">false</strong>: instant detection. Instant detection immediately ends threat detection after blocking a request that meets Precise Protection specified conditions.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row66308345"><td class="cellrowborder" valign="top" width="24.3975602439756%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0031__p2266842">hosts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.80641935806419%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0031__p49396545">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0031__p41697171">Specifies the domain IDs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row39730225"><td class="cellrowborder" valign="top" width="24.3975602439756%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0031__p64031633">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.80641935806419%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0031__p19179794">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0031__p10059483">Specifies the time when a policy is created.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0031__table1231716412312"></a><a name="table1231716412312"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0031__table1231716412312" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="waf_02_0031__b19730164917234">action</strong></caption><thead align="left"><tr id="waf_02_0031__row153241848236"><th align="left" class="cellrowborder" valign="top" width="25.407459254074595%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0031__p1532615432319"><strong id="waf_02_0031__b1603906441">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.796520347965206%" id="mcps1.3.4.3.2.4.1.2"><p id="waf_02_0031__p333054192311"><strong id="waf_02_0031__b1626761878">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.4.3.2.4.1.3"><p id="waf_02_0031__p193322492311"><strong id="waf_02_0031__b2045989521">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0031__row19763216142319"><td class="cellrowborder" valign="top" width="25.407459254074595%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0031__p1576317163239">category</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.796520347965206%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0031__p117631516182318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0031__p676312167234">Specifies the protective action.</p>
|
|
<ul id="waf_02_0031__ul1392521423713"><li id="waf_02_0031__li5926614173713"><span class="parmvalue" id="waf_02_0031__parmvalue438075817288"><b>block</b></span>: WAF blocks and logs detected attacks.</li><li id="waf_02_0031__li10930111403713"><span class="parmvalue" id="waf_02_0031__parmvalue224561115327"><b>log</b></span>: WAF logs detected attacks only.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0031__table1272813819259"></a><a name="table1272813819259"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0031__table1272813819259" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="waf_02_0031__b828315682615">options</strong></caption><thead align="left"><tr id="waf_02_0031__row14733082258"><th align="left" class="cellrowborder" valign="top" width="27.117288271172878%" id="mcps1.3.4.4.2.4.1.1"><p id="waf_02_0031__p873817812512"><strong id="waf_02_0031__b1428562748">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.4.2.4.1.2"><p id="waf_02_0031__p137404817256"><strong id="waf_02_0031__b1784827860">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.4.2.4.1.3"><p id="waf_02_0031__p6742198152512"><strong id="waf_02_0031__b965611029">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0031__row1177747172812"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p33504133">webattack</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p29480242">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p2415193218263">Specifies whether Basic Web Protection is enabled.</p>
|
|
<ul id="waf_02_0031__ul1778444132612"><li id="waf_02_0031__li1678115440265"><strong id="waf_02_0031__b2400155093115">true</strong>: enabled.</li><li id="waf_02_0031__li1378544482616"><strong id="waf_02_0031__b936485615312">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row1577720732819"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p42476939">common</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p18080074">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p8672433268">Specifies whether General Check in Basic Web Protection is enabled.</p>
|
|
<ul id="waf_02_0031__ul4842171218268"><li id="waf_02_0031__li65215555299"><strong id="waf_02_0031__b846711493217">true</strong>: enabled.</li><li id="waf_02_0031__li1558185582916"><strong id="waf_02_0031__b09811697321">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row8777157112811"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p47260058">crawler</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p2859499">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p825744922615">Specifies whether the master crawler detection switch in Basic Web Protection is enabled.</p>
|
|
<ul id="waf_02_0031__ul2993535262"><li id="waf_02_0031__li810115342614"><strong id="waf_02_0031__b6200201818328">true</strong>: enabled.</li><li id="waf_02_0031__li7106145312265"><strong id="waf_02_0031__b1077992123215">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row1177515762814"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p42166705">crawler_engine</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p60059924">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p1718417589268">Specifies whether the Search Engine switch in Basic Web Protection is enabled.</p>
|
|
<ul id="waf_02_0031__ul172713111276"><li id="waf_02_0031__li133019142713"><strong id="waf_02_0031__b1627815296323">true</strong>: enabled.</li><li id="waf_02_0031__li632911271"><strong id="waf_02_0031__b126696328326">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row177751776289"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p55359439">crawler_scanner</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p54929604">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p20112962">Specifies whether the Scanner switch in Basic Web Protection is enabled.</p>
|
|
<ul id="waf_02_0031__ul851114810278"><li id="waf_02_0031__li55133813278"><strong id="waf_02_0031__b19895154973215">true</strong>: enabled.</li><li id="waf_02_0031__li951619811273"><strong id="waf_02_0031__b1949353153214">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row177577172811"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p25118198">crawler_script</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p21308157">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p48239148">Specifies whether the Script Tool switch in Basic Web Protection is enabled.</p>
|
|
<ul id="waf_02_0031__ul1296981219278"><li id="waf_02_0031__li1971101217270"><strong id="waf_02_0031__b39783017338">true</strong>: enabled.</li><li id="waf_02_0031__li1297411292712"><strong id="waf_02_0031__b6111174203311">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row1773576281"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p11652645">crawler_other</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p4340158">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p16008479">Specifies whether detection of other crawlers in Basic Web Protection is enabled.</p>
|
|
<ul id="waf_02_0031__ul8824161782711"><li id="waf_02_0031__li18269173273"><strong id="waf_02_0031__b19432191315334">true</strong>: enabled.</li><li id="waf_02_0031__li15830417112712"><strong id="waf_02_0031__b455117177338">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row1177357102817"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p6261339">webshell</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p37406470">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p10025242">Specifies whether webshell detection in Basic Web Protection is enabled.</p>
|
|
<ul id="waf_02_0031__ul20574202914279"><li id="waf_02_0031__li16574102917275"><strong id="waf_02_0031__b149031527193313">true</strong>: enabled.</li><li id="waf_02_0031__li257772972712"><strong id="waf_02_0031__b199571730153317">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row47721722816"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p8926362">cc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p51946711">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p46934044">Specifies whether CC Attack Protection is enabled.</p>
|
|
<ul id="waf_02_0031__ul8527033142710"><li id="waf_02_0031__li1252923332710"><strong id="waf_02_0031__b165911138113318">true</strong>: enabled.</li><li id="waf_02_0031__li165321133112714"><strong id="waf_02_0031__b8536134183315">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row1977218711283"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p38799072">custom</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p55717167">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p16796711">Specifies whether Precise Protection is enabled.</p>
|
|
<ul id="waf_02_0031__ul1043194117270"><li id="waf_02_0031__li74754142718"><strong id="waf_02_0031__b17653164912339">true</strong>: enabled.</li><li id="waf_02_0031__li175084162710"><strong id="waf_02_0031__b288885220337">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row97728782819"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p10468143">whiteblackip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p42613264">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p29122361">Specifies whether Blacklist and Whitelist is enabled.</p>
|
|
<ul id="waf_02_0031__ul1621718455274"><li id="waf_02_0031__li182183459278"><strong id="waf_02_0031__b5651140173415">true</strong>: enabled.</li><li id="waf_02_0031__li1522294592713"><strong id="waf_02_0031__b1460512318345">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row10772157172818"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p51392996">privacy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p2083177">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p34519671">Specifies whether Data Masking is enabled.</p>
|
|
<ul id="waf_02_0031__ul2712175332710"><li id="waf_02_0031__li157141535274"><strong id="waf_02_0031__b796511108344">true</strong>: enabled.</li><li id="waf_02_0031__li11717145312278"><strong id="waf_02_0031__b109481713173419">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row14770678287"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p58255435">Ignore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p21069794">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p28931745">Specifies whether False Alarm Masking is enabled.</p>
|
|
<ul id="waf_02_0031__ul1371357192720"><li id="waf_02_0031__li1671155782712"><strong id="waf_02_0031__b9722423193416">true</strong>: enabled.</li><li id="waf_02_0031__li147415782716"><strong id="waf_02_0031__b18784123017347">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0031__row167707717287"><td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0031__p37316794">antitamper</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0031__p2761443">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0031__p22350292">Specifies whether Web Tamper Protection is enabled.</p>
|
|
<ul id="waf_02_0031__ul5509133182819"><li id="waf_02_0031__li35108316281"><strong id="waf_02_0031__b6387173913349">true</strong>: enabled.</li><li id="waf_02_0031__li15515735289"><strong id="waf_02_0031__b2085513425344">false</strong>: disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0031__section1904124824012"><h4 class="sectiontitle">Example</h4><p id="waf_02_0031__p3546162919360">A policy named <strong id="waf_02_0031__b12970136174314">policy_2</strong> is used as an example.</p>
|
|
<div class="p" id="waf_02_0031__p17013212416">Response example<pre class="screen" id="waf_02_0031__screen1292211481401">{
|
|
"id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
|
|
"name": "policy_2",
|
|
"action": {
|
|
"category": "block"
|
|
},
|
|
"options": {
|
|
"webattack": true,
|
|
"common": true,
|
|
"crawler": true,
|
|
"crawler_engine": true,
|
|
"crawler_scanner": true,
|
|
"crawler_script": true,
|
|
"crawler_other": true,
|
|
"webshell": true,
|
|
"cc": true,
|
|
"custom": true,
|
|
"whiteblackip": true,
|
|
"ignore": true,
|
|
"privacy": true,
|
|
"antitamper": true
|
|
},
|
|
"level": 1,
|
|
"full_detection": false,
|
|
"hosts": ["11111111111111111", "2222222222222222222"],
|
|
"timestamp": 1499817612
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0031__section51714589"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0031__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0031__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 5</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0031__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0031__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="waf_02_0031__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_0031__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_0031__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_0031__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0031__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_0031__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_0031__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_0031__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0031__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_0028.html">Policies</a></div>
|
|
</div>
|
|
</div>
|
|
|