vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/waf/api-ref/waf_02_0029.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

399 lines
33 KiB
HTML
Raw Blame History

<a name="waf_02_0029"></a><a name="waf_02_0029"></a>
<h1 class="topictitle1">Querying All Policies</h1>
<div id="body58874259"><div class="section" id="waf_02_0029__section28622093"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0029__p4085642">This API is used to query the list of policies.</p>
</div>
<div class="section" id="waf_02_0029__section56272247"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0029__ul62501606"><li id="waf_02_0029__li25643550">URI format<p id="waf_02_0029__p29465359"><a name="waf_02_0029__li25643550"></a><a name="li25643550"></a>GET /v1/{project_id}/waf/policy?policyname={policyname}&amp;offset={offset}&amp;limit={limit}</p>
</li><li id="waf_02_0029__li63861644">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0029__table37883884" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0029__row23757768"><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_0029__p45331073"><strong id="waf_02_0029__b2482145517489">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_0029__p47938266"><strong id="waf_02_0029__b1854525617485">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_0029__p57794299"><strong id="waf_02_0029__b1545275714486">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_0029__p50826637"><strong id="waf_02_0029__b10248958134815">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0029__row23316919"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0029__p9622306">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_0029__p41209334">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_0029__p49621721">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_0029__p59936502">Specifies the project ID.</p>
</td>
</tr>
<tr id="waf_02_0029__row11211381519"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0029__p42119389119">policyname</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_0029__p9218381610">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_0029__p202103812118">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_0029__p182119380119">Specifies the policy name. GET /v1/{project_id}/waf/policy/{policy_id}/whiteblackip?offset={offset}&amp;limit={limit}</p>
</td>
</tr>
<tr id="waf_02_0029__row11348153413310"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0029__p5348123414331">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_0029__p16348534203314">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_0029__p133481934113314">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_0029__p21617533">Specifies the number of returned pages. Its value ranges from <strong id="waf_02_0029__b117610326338">0</strong> to <strong id="waf_02_0029__b676118325331">65535</strong>. The default value is <strong id="waf_02_0029__b137611324331">0</strong>.</p>
</td>
</tr>
<tr id="waf_02_0029__row643410397338"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0029__p2043413395331">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_0029__p14344392332">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_0029__p14341539143310">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_0029__p25357967">Specifies the maximum number of records displayed on each page. Value range: (<strong id="waf_02_0029__b922013353335">0</strong>, <strong id="waf_02_0029__b2220535183314">10</strong>]. The default value is <strong id="waf_02_0029__b6220143518334">10</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="waf_02_0029__section36688176"><h4 class="sectiontitle">Request</h4><p id="waf_02_0029__p1981612183914">Request parameters</p>
<p class="msonormal" id="waf_02_0029__p23018483">None</p>
</div>
<div class="section" id="waf_02_0029__section61758129"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0029__p4214171123914">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0029__table29324718" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0029__row1824515"><th align="left" class="cellrowborder" valign="top" width="24.490000000000002%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0029__p13568011"><strong id="waf_02_0029__b183191255133414">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.889999999999997%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0029__p25267083"><strong id="waf_02_0029__b14490145610343">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.620000000000005%" id="mcps1.3.4.2.1.2.4.1.3"><p id="waf_02_0029__p33367852"><strong id="waf_02_0029__b15381857123414">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0029__row31875216"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0029__p31755717">total</p>
</td>
<td class="cellrowborder" valign="top" width="26.889999999999997%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0029__p22076270">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.620000000000005%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0029__p43347444">Specifies the total number of policies.</p>
</td>
</tr>
<tr id="waf_02_0029__row54582677"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0029__p59120688">items</p>
</td>
<td class="cellrowborder" valign="top" width="26.889999999999997%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0029__p24046428"><a href="#waf_02_0029__table16394183011019">Table 3</a></p>
</td>
<td class="cellrowborder" valign="top" width="48.620000000000005%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0029__p1603648">Specifies the policy objects.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="waf_02_0029__table16394183011019"></a><a name="table16394183011019"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0029__table16394183011019" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="waf_02_0029__b108233320226">items</strong></caption><thead align="left"><tr id="waf_02_0029__row939613301015"><th align="left" class="cellrowborder" valign="top" width="24.317568243175682%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0029__p039873016013"><strong id="waf_02_0029__b1499244423911">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.44715528447155%" id="mcps1.3.4.3.2.4.1.2"><p id="waf_02_0029__p183997301406"><strong id="waf_02_0029__b143029511">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.235276472352766%" id="mcps1.3.4.3.2.4.1.3"><p id="waf_02_0029__p839973013010"><strong id="waf_02_0029__b829091164210">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0029__row194014521190"><td class="cellrowborder" valign="top" width="24.317568243175682%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0029__p7293351101918">id</p>
</td>
<td class="cellrowborder" valign="top" width="28.44715528447155%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0029__p172941251111914">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.235276472352766%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0029__p18296155114199">Specifies the instance ID.</p>
</td>
</tr>
<tr id="waf_02_0029__row14400165214191"><td class="cellrowborder" valign="top" width="24.317568243175682%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0029__p16298451151910">name</p>
</td>
<td class="cellrowborder" valign="top" width="28.44715528447155%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0029__p10301145141917">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.235276472352766%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0029__p630115191919">Specifies the policy name.</p>
</td>
</tr>
<tr id="waf_02_0029__row4399125231910"><td class="cellrowborder" valign="top" width="24.317568243175682%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0029__p030425113191">options</p>
</td>
<td class="cellrowborder" valign="top" width="28.44715528447155%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0029__p230513514195"><a href="#waf_02_0029__table1272813819259">Table 4</a></p>
</td>
<td class="cellrowborder" valign="top" width="47.235276472352766%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0029__p53051151171910">Specifies whether a protection rule is enabled.</p>
</td>
</tr>
<tr id="waf_02_0029__row2039965210196"><td class="cellrowborder" valign="top" width="24.317568243175682%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0029__p730815119192">action</p>
</td>
<td class="cellrowborder" valign="top" width="28.44715528447155%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0029__p113117519190"><a href="#waf_02_0029__table1231716412312">Table 5</a></p>
</td>
<td class="cellrowborder" valign="top" width="47.235276472352766%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0029__p15312145131919">Specifies the mode of Basic Web Protection.</p>
<ul id="waf_02_0029__ul796714441001"><li id="waf_02_0029__li836931317112"><span class="parmvalue" id="waf_02_0029__parmvalue159619421115"><b>block</b></span>: WAF blocks and logs detected attacks.</li><li id="waf_02_0029__li1967844901"><span class="parmvalue" id="waf_02_0029__parmvalue1516014017161"><b>log</b></span>: WAF logs detected attacks only.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row15398165221918"><td class="cellrowborder" valign="top" width="24.317568243175682%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0029__p14314451101911">level</p>
</td>
<td class="cellrowborder" valign="top" width="28.44715528447155%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0029__p19315195115194">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="47.235276472352766%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0029__p63171351161911">Specifies the protection level.</p>
<ul id="waf_02_0029__ul1581418916465"><li id="waf_02_0029__li981499174615"><span class="parmvalue" id="waf_02_0029__parmvalue679391714614"><b>1</b></span>: low<p id="waf_02_0029__p2704173810911">WAF detects wget, cURL, and more but does not detect XSS and command injection attacks in the header, so you may miss more vulnerabilities that in fact exist. If you find out that configured protection rules are affecting your services, adjust the protection level to <strong id="waf_02_0029__b9925740102218">1</strong>.</p>
</li><li id="waf_02_0029__li202801342465"><span class="parmvalue" id="waf_02_0029__parmvalue182811934154613"><b>2</b></span>: medium<p id="waf_02_0029__p2954125761410">By default, <strong id="waf_02_0029__b66847143116">2</strong> is selected. In this level, WAF detects remote file inclusion, third-party software vulnerabilities, webshell, and cp and ftp commands.</p>
</li><li id="waf_02_0029__li73191211102"><span class="parmvalue" id="waf_02_0029__parmvalue161671854125317"><b>3</b></span>: high<p id="waf_02_0029__p1170119411103">WAF detects Netcat, Nmap, kill commands, and more. If you need stricter protection, select <strong id="waf_02_0029__b12577117105015">3</strong> to avoid unreported vulnerabilities but you may see more vulnerabilities that in fact unlikely exist.</p>
</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row93971052141920"><td class="cellrowborder" valign="top" width="24.317568243175682%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0029__p2032145161915">full_detection</p>
</td>
<td class="cellrowborder" valign="top" width="28.44715528447155%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0029__p15324185118193">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="47.235276472352766%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0029__p29333486463">Specifies the detection mode in Precise Protection.</p>
<ul id="waf_02_0029__ul38041853194616"><li id="waf_02_0029__li4804353104611"><strong id="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_0029__li318133918612"><strong id="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_0029__row12397175219190"><td class="cellrowborder" valign="top" width="24.317568243175682%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0029__p2033015513197">hosts</p>
</td>
<td class="cellrowborder" valign="top" width="28.44715528447155%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0029__p1333111513192">Array</p>
</td>
<td class="cellrowborder" valign="top" width="47.235276472352766%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0029__p133317514190">Specifies the domain IDs.</p>
</td>
</tr>
<tr id="waf_02_0029__row10396152101911"><td class="cellrowborder" valign="top" width="24.317568243175682%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0029__p1033511516193">timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="28.44715528447155%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0029__p7337551141917">Long</p>
</td>
<td class="cellrowborder" valign="top" width="47.235276472352766%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0029__p733813519190">Specifies the time when a policy is created.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="waf_02_0029__table1272813819259"></a><a name="table1272813819259"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0029__table1272813819259" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="waf_02_0029__b0407102034918">options</strong></caption><thead align="left"><tr id="waf_02_0029__row14733082258"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.4.2.4.1.1"><p id="waf_02_0029__p873817812512"><strong id="waf_02_0029__b103701112153414">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.117288271172878%" id="mcps1.3.4.4.2.4.1.2"><p id="waf_02_0029__p137404817256"><strong id="waf_02_0029__b1722206271">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_0029__p6742198152512"><strong id="waf_02_0029__b03231114173410">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0029__row1177747172812"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p33504133">webattack</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p2415193218263">Specifies whether Basic Web Protection is enabled.</p>
<ul id="waf_02_0029__ul1778444132612"><li id="waf_02_0029__li1678115440265"><strong id="waf_02_0029__b54581648130">true</strong>: enabled.</li><li id="waf_02_0029__li1378544482616"><strong id="waf_02_0029__b334971114131">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row1577720732819"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p42476939">common</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p8672433268">Specifies whether General Check in Basic Web Protection is enabled.</p>
<ul id="waf_02_0029__ul4842171218268"><li id="waf_02_0029__li65215555299"><strong id="waf_02_0029__b288694691319">true</strong>: enabled.</li><li id="waf_02_0029__li1558185582916"><strong id="waf_02_0029__b1646225071312">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row8777157112811"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p47260058">crawler</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p825744922615">Specifies whether the master crawler detection switch in Basic Web Protection is enabled.</p>
<ul id="waf_02_0029__ul2993535262"><li id="waf_02_0029__li810115342614"><strong id="waf_02_0029__b146041519171410">true</strong>: enabled.</li><li id="waf_02_0029__li7106145312265"><strong id="waf_02_0029__b18213235142">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row1177515762814"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p42166705">crawler_engine</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p1718417589268">Specifies whether the Search Engine switch in Basic Web Protection is enabled.</p>
<ul id="waf_02_0029__ul172713111276"><li id="waf_02_0029__li133019142713"><strong id="waf_02_0029__b9432945171419">true</strong>: enabled.</li><li id="waf_02_0029__li632911271"><strong id="waf_02_0029__b47998487142">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row177751776289"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p55359439">crawler_scanner</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p20112962">Specifies whether the Scanner switch in Basic Web Protection is enabled.</p>
<ul id="waf_02_0029__ul851114810278"><li id="waf_02_0029__li55133813278"><strong id="waf_02_0029__b75571644161511">true</strong>: enabled.</li><li id="waf_02_0029__li951619811273"><strong id="waf_02_0029__b13881151121514">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row177577172811"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p25118198">crawler_script</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p48239148">Specifies whether the Script Tool switch in Basic Web Protection is enabled.</p>
<ul id="waf_02_0029__ul1296981219278"><li id="waf_02_0029__li1971101217270"><strong id="waf_02_0029__b26179159164">true</strong>: enabled.</li><li id="waf_02_0029__li1297411292712"><strong id="waf_02_0029__b193422199167">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row1773576281"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p11652645">crawler_other</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p16008479">Specifies whether detection of other crawlers in Basic Web Protection is enabled.</p>
<ul id="waf_02_0029__ul8824161782711"><li id="waf_02_0029__li18269173273"><strong id="waf_02_0029__b186981542191619">true</strong>: enabled.</li><li id="waf_02_0029__li15830417112712"><strong id="waf_02_0029__b058004671610">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row1177357102817"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p6261339">webshell</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p10025242">Specifies whether webshell detection in Basic Web Protection is enabled.</p>
<ul id="waf_02_0029__ul20574202914279"><li id="waf_02_0029__li16574102917275"><strong id="waf_02_0029__b66691125176">true</strong>: enabled.</li><li id="waf_02_0029__li257772972712"><strong id="waf_02_0029__b1429131619175">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row47721722816"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p8926362">cc</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p46934044">Specifies whether CC Attack Protection is enabled.</p>
<ul id="waf_02_0029__ul8527033142710"><li id="waf_02_0029__li1252923332710"><strong id="waf_02_0029__b126301931141717">true</strong>: enabled.</li><li id="waf_02_0029__li165321133112714"><strong id="waf_02_0029__b10708137151720">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row1977218711283"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p38799072">custom</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p16796711">Specifies whether Precise Protection is enabled.</p>
<ul id="waf_02_0029__ul1043194117270"><li id="waf_02_0029__li74754142718"><strong id="waf_02_0029__b19858155619174">true</strong>: enabled.</li><li id="waf_02_0029__li175084162710"><strong id="waf_02_0029__b15460120111811">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row97728782819"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p10468143">whiteblackip</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p29122361">Specifies whether Blacklist and Whitelist is enabled.</p>
<ul id="waf_02_0029__ul1621718455274"><li id="waf_02_0029__li182183459278"><strong id="waf_02_0029__b10631111615186">true</strong>: enabled.</li><li id="waf_02_0029__li1522294592713"><strong id="waf_02_0029__b129671319131820">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row10772157172818"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p51392996">privacy</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p34519671">Specifies whether Data Masking is enabled.</p>
<ul id="waf_02_0029__ul2712175332710"><li id="waf_02_0029__li157141535274"><strong id="waf_02_0029__b6452335189">true</strong>: enabled.</li><li id="waf_02_0029__li11717145312278"><strong id="waf_02_0029__b765412362186">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row14770678287"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p58255435">Ignore</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p28931745">Specifies whether False Alarm Masking is enabled.</p>
<ul id="waf_02_0029__ul1371357192720"><li id="waf_02_0029__li1671155782712"><strong id="waf_02_0029__b15443134613184">true</strong>: enabled.</li><li id="waf_02_0029__li147415782716"><strong id="waf_02_0029__b871624911820">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0029__row167707717287"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0029__p37316794">antitamper</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0029__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_0029__p22350292">Specifies whether Web Tamper Protection is enabled.</p>
<ul id="waf_02_0029__ul5509133182819"><li id="waf_02_0029__li35108316281"><strong id="waf_02_0029__b1049758141814">true</strong>: enabled.</li><li id="waf_02_0029__li15515735289"><strong id="waf_02_0029__b1158001141914">false</strong>: disabled.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="waf_02_0029__table1231716412312"></a><a name="table1231716412312"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0029__table1231716412312" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="waf_02_0029__b1882093210495">action</strong></caption><thead align="left"><tr id="waf_02_0029__row153241848236"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.5.2.4.1.1"><p id="waf_02_0029__p1532615432319"><strong id="waf_02_0029__b88824110">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.117288271172878%" id="mcps1.3.4.5.2.4.1.2"><p id="waf_02_0029__p333054192311"><strong id="waf_02_0029__b681840019">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.5.2.4.1.3"><p id="waf_02_0029__p193322492311"><strong id="waf_02_0029__b266307620">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0029__row19763216142319"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.5.2.4.1.1 "><p id="waf_02_0029__p1576317163239">category</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.5.2.4.1.2 "><p id="waf_02_0029__p117631516182318">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.5.2.4.1.3 "><p id="waf_02_0029__p676312167234">Specifies the mode of Basic Web Protection.</p>
<ul id="waf_02_0029__ul1638352216361"><li id="waf_02_0029__li1038522210366"><span class="parmvalue" id="waf_02_0029__parmvalue103251837112518"><b>block</b></span>: WAF blocks and logs detected attacks.</li><li id="waf_02_0029__li10393222113615"><span class="parmvalue" id="waf_02_0029__parmvalue577183311619"><b>log</b></span>: WAF logs detected attacks only.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="waf_02_0029__section145741224193916"><h4 class="sectiontitle">Example</h4><p id="waf_02_0029__p16808092290"><strong id="waf_02_0029__b07792016437">total</strong> with a value of <strong id="waf_02_0029__b37795015436">2</strong> is used as an example.</p>
<div class="p" id="waf_02_0029__p3627730123913">Response example<pre class="screen" id="waf_02_0029__screen9610172483913">{
"total": 2,
"items": [
{
"id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "policy_1",
"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
}, {
"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_0029__section18952251"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0029__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0029__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 6</a> describes the normal status code returned by the API.
<div class="tablenoborder"><a name="waf_02_0029__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0029__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Status code</caption><thead align="left"><tr id="waf_02_0029__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_0029__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_0029__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_0029__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0029__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_0029__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_0029__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_0029__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="waf_02_0029__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>
View Git Blame Copy Permalink