doc-exports/docs/waf/api-ref/waf_02_0032.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

349 lines
29 KiB
HTML

<a name="waf_02_0032"></a><a name="waf_02_0032"></a>
<h1 class="topictitle1">Applying a Policy to Domain Names</h1>
<div id="body26547474"><div class="section" id="waf_02_0032__section53777129"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0032__p2861810">This API is used to apply a policy to domain names.</p>
</div>
<div class="section" id="waf_02_0032__section14232118"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0032__ul30480075"><li id="waf_02_0032__li5885220">URI format<p id="waf_02_0032__p52966980"><a name="waf_02_0032__li5885220"></a><a name="li5885220"></a>PUT /v1/{project_id}/waf/policy/{policy_id}/hosts</p>
</li><li id="waf_02_0032__li6940772">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0032__table62466949" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0032__row28829553"><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_0032__p53492480"><strong id="waf_02_0032__b624512501175">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_0032__p37923619"><strong id="waf_02_0032__b87586468195">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_0032__p51914307"><strong id="waf_02_0032__b138226476199">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_0032__p44309319"><strong id="waf_02_0032__b13805144831918">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0032__row32285080"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0032__p64954653">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_0032__p26835518">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_0032__p26193381">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_0032__p41289079">Specifies the project ID.</p>
</td>
</tr>
<tr id="waf_02_0032__row36057397"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0032__p34968021">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_0032__p13837462">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_0032__p47092639">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_0032__p56407449">Specifies the policy ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="waf_02_0032__section60980198"><h4 class="sectiontitle">Request</h4><div class="p" id="waf_02_0032__p985715194118">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0032__table32705923" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0032__row51664566"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.1.2.5.1.1"><p id="waf_02_0032__p24080287"><strong id="waf_02_0032__b1819036812">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_0032__p4346192"><strong id="waf_02_0032__b1712426265">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.3.2.1.2.5.1.3"><p id="waf_02_0032__p16497266"><strong id="waf_02_0032__b754689166">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.3.2.1.2.5.1.4"><p id="waf_02_0032__p61210156"><strong id="waf_02_0032__b1174883833">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0032__row59075623"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0032__p20396171">hosts</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0032__p41477118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0032__p4203435">List</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0032__p4933944">Specifies the domain IDs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="waf_02_0032__section11950876"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0032__p7578448114113">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0032__table64914630" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0032__row45118507"><th align="left" class="cellrowborder" valign="top" width="26.657334266573336%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0032__p30720454"><strong id="waf_02_0032__b629335564915">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.546645335466444%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0032__p5328821"><strong id="waf_02_0032__b1296555610495">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_0032__p28981345"><strong id="waf_02_0032__b73002586498">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0032__row59505513"><td class="cellrowborder" valign="top" width="26.657334266573336%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0032__p55217210">id</p>
</td>
<td class="cellrowborder" valign="top" width="33.546645335466444%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0032__p43409020">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_0032__p26469718">Specifies the policy ID.</p>
</td>
</tr>
<tr id="waf_02_0032__row36900876"><td class="cellrowborder" valign="top" width="26.657334266573336%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0032__p36180990">name</p>
</td>
<td class="cellrowborder" valign="top" width="33.546645335466444%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0032__p44979101">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_0032__p19428560">Specifies the policy name.</p>
</td>
</tr>
<tr id="waf_02_0032__row40639317"><td class="cellrowborder" valign="top" width="26.657334266573336%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0032__p3450370">action</p>
</td>
<td class="cellrowborder" valign="top" width="33.546645335466444%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0032__p11044535"><a href="#waf_02_0032__table1231716412312">Table 4</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_0032__p22192157">Specifies the protective action after a rule is matched.</p>
<ul id="waf_02_0032__ul796714441001"><li id="waf_02_0032__li836931317112"><span class="parmvalue" id="waf_02_0032__parmvalue153416405295"><b>block</b></span>: WAF blocks and logs detected attacks.</li><li id="waf_02_0032__li1967844901"><span class="parmvalue" id="waf_02_0032__parmvalue12873191210349"><b>log</b></span>: WAF logs detected attacks only.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row35894686"><td class="cellrowborder" valign="top" width="26.657334266573336%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0032__p21788414">options</p>
</td>
<td class="cellrowborder" valign="top" width="33.546645335466444%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0032__p20031082"><a href="#waf_02_0032__table1272813819259">Table 5</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_0032__p11904971">Specifies the protection switches.</p>
</td>
</tr>
<tr id="waf_02_0032__row66773820"><td class="cellrowborder" valign="top" width="26.657334266573336%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0032__p39970328">level</p>
</td>
<td class="cellrowborder" valign="top" width="33.546645335466444%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0032__p16371096">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_0032__p8528528245">Specifies the protection level.</p>
<ul id="waf_02_0032__ul14533143918414"><li id="waf_02_0032__li1653519392418"><span class="parmvalue" id="waf_02_0032__parmvalue9145185104513"><b>1</b></span>: low</li><li id="waf_02_0032__li155352391947"><span class="parmvalue" id="waf_02_0032__parmvalue2770185614459"><b>2</b></span>: medium</li><li id="waf_02_0032__li6535183919419"><span class="parmvalue" id="waf_02_0032__parmvalue1779365984517"><b>3</b></span>: high</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row56260171"><td class="cellrowborder" valign="top" width="26.657334266573336%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0032__p60779989">full_detection</p>
</td>
<td class="cellrowborder" valign="top" width="33.546645335466444%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0032__p24232096">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0032__p68421843104420">Specifies the detection mode in Precise Protection.</p>
<ul id="waf_02_0032__ul02880554511"><li id="waf_02_0032__waf_02_0029_li4804353104611"><strong id="waf_02_0032__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_0032__waf_02_0029_li318133918612"><strong id="waf_02_0032__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_0032__row15567220"><td class="cellrowborder" valign="top" width="26.657334266573336%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0032__p52985303">hosts</p>
</td>
<td class="cellrowborder" valign="top" width="33.546645335466444%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0032__p63951159">Array</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0032__p12661371">Specifies the domain IDs.</p>
</td>
</tr>
<tr id="waf_02_0032__row46843478"><td class="cellrowborder" valign="top" width="26.657334266573336%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0032__p36225388">timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="33.546645335466444%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0032__p48575322">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_0032__p42287049">Specifies the time when a policy is created.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="waf_02_0032__table1231716412312"></a><a name="table1231716412312"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0032__table1231716412312" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="waf_02_0032__b20617105612272">action</strong></caption><thead align="left"><tr id="waf_02_0032__row153241848236"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0032__p1532615432319"><strong id="waf_02_0032__b1242335045">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_0032__p333054192311"><strong id="waf_02_0032__b606394206">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_0032__p193322492311"><strong id="waf_02_0032__b1244499594">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0032__row19763216142319"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0032__p1576317163239">category</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0032__p117631516182318">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0032__p676312167234">Specifies the protective action.</p>
<ul id="waf_02_0032__ul6757153383716"><li id="waf_02_0032__li4758163383714"><span class="parmvalue" id="waf_02_0032__parmvalue95611462322"><b>block</b></span>: block and log detected attacks.</li><li id="waf_02_0032__li1076223353710"><span class="parmvalue" id="waf_02_0032__parmvalue7859193618341"><b>log</b></span>: only log detected attacks.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="waf_02_0032__table1272813819259"></a><a name="table1272813819259"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0032__table1272813819259" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="waf_02_0032__b1966427142812">options</strong></caption><thead align="left"><tr id="waf_02_0032__row14733082258"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.4.2.4.1.1"><p id="waf_02_0032__p873817812512"><strong id="waf_02_0032__b82863102">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_0032__p137404817256"><strong id="waf_02_0032__b1425684832">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_0032__p6742198152512"><strong id="waf_02_0032__b597130664">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0032__row1177747172812"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p2415193218263">Specifies whether Basic Web Protection is enabled.</p>
<ul id="waf_02_0032__ul1778444132612"><li id="waf_02_0032__li1678115440265"><strong id="waf_02_0032__b0688110134713">true</strong>: enabled.</li><li id="waf_02_0032__li1378544482616"><strong id="waf_02_0032__b1732894114718">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row1577720732819"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p8672433268">Specifies whether General Check in Basic Web Protection is enabled.</p>
<ul id="waf_02_0032__ul4842171218268"><li id="waf_02_0032__li65215555299"><strong id="waf_02_0032__b117141354714">true</strong>: enabled.</li><li id="waf_02_0032__li1558185582916"><strong id="waf_02_0032__b196027199470">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row8777157112811"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p825744922615">Specifies whether the master crawler detection switch in Basic Web Protection is enabled.</p>
<ul id="waf_02_0032__ul2993535262"><li id="waf_02_0032__li810115342614"><strong id="waf_02_0032__b1723562854719">true</strong>: enabled.</li><li id="waf_02_0032__li7106145312265"><strong id="waf_02_0032__b4552323471">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row1177515762814"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p1718417589268">Specifies whether the Search Engine switch in Basic Web Protection is enabled.</p>
<ul id="waf_02_0032__ul172713111276"><li id="waf_02_0032__li133019142713"><strong id="waf_02_0032__b9762640134712">true</strong>: enabled.</li><li id="waf_02_0032__li632911271"><strong id="waf_02_0032__b1316684464720">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row177751776289"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p20112962">Specifies whether the Scanner switch in Basic Web Protection is enabled.</p>
<ul id="waf_02_0032__ul851114810278"><li id="waf_02_0032__li55133813278"><strong id="waf_02_0032__b1241713616489">true</strong>: enabled.</li><li id="waf_02_0032__li951619811273"><strong id="waf_02_0032__b755820125489">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row177577172811"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p48239148">Specifies whether the Script Tool switch in Basic Web Protection is enabled.</p>
<ul id="waf_02_0032__ul1296981219278"><li id="waf_02_0032__li1971101217270"><strong id="waf_02_0032__b1279110205485">true</strong>: enabled.</li><li id="waf_02_0032__li1297411292712"><strong id="waf_02_0032__b37111244486">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row1773576281"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p16008479">Specifies whether detection of other crawlers in Basic Web Protection is enabled.</p>
<ul id="waf_02_0032__ul8824161782711"><li id="waf_02_0032__li18269173273"><strong id="waf_02_0032__b1646113406488">true</strong>: enabled.</li><li id="waf_02_0032__li15830417112712"><strong id="waf_02_0032__b20727443194819">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row1177357102817"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p10025242">Specifies whether webshell detection in Basic Web Protection is enabled.</p>
<ul id="waf_02_0032__ul20574202914279"><li id="waf_02_0032__li16574102917275"><strong id="waf_02_0032__b521617118491">true</strong>: enabled.</li><li id="waf_02_0032__li257772972712"><strong id="waf_02_0032__b141456496">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row47721722816"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p46934044">Specifies whether CC Attack Protection is enabled.</p>
<ul id="waf_02_0032__ul8527033142710"><li id="waf_02_0032__li1252923332710"><strong id="waf_02_0032__b1346591612490">true</strong>: enabled.</li><li id="waf_02_0032__li165321133112714"><strong id="waf_02_0032__b14832111964917">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row1977218711283"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p16796711">Specifies whether Precise Protection is enabled.</p>
<ul id="waf_02_0032__ul1043194117270"><li id="waf_02_0032__li74754142718"><strong id="waf_02_0032__b1567133764912">true</strong>: enabled.</li><li id="waf_02_0032__li175084162710"><strong id="waf_02_0032__b36291640104917">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row97728782819"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p29122361">Specifies whether Blacklist and Whitelist is enabled.</p>
<ul id="waf_02_0032__ul1621718455274"><li id="waf_02_0032__li182183459278"><strong id="waf_02_0032__b420048194913">true</strong>: enabled.</li><li id="waf_02_0032__li1522294592713"><strong id="waf_02_0032__b15200451124911">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row10772157172818"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p34519671">Specifies whether Data Masking is enabled.</p>
<ul id="waf_02_0032__ul2712175332710"><li id="waf_02_0032__li157141535274"><strong id="waf_02_0032__b5656115944913">true</strong>: enabled.</li><li id="waf_02_0032__li11717145312278"><strong id="waf_02_0032__b98677215012">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row14770678287"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p28931745">Specifies whether False Alarm Masking is enabled.</p>
<ul id="waf_02_0032__ul1371357192720"><li id="waf_02_0032__li1671155782712"><strong id="waf_02_0032__b1632313175016">true</strong>: enabled.</li><li id="waf_02_0032__li147415782716"><strong id="waf_02_0032__b1799271612508">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="waf_02_0032__row167707717287"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0032__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_0032__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_0032__p22350292">Specifies whether Web Tamper Protection is enabled.</p>
<ul id="waf_02_0032__ul5509133182819"><li id="waf_02_0032__li35108316281"><strong id="waf_02_0032__b09161829155116">true</strong>: enabled.</li><li id="waf_02_0032__li15515735289"><strong id="waf_02_0032__b149788329514">false</strong>: disabled.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="waf_02_0032__section11561926164114"><h4 class="sectiontitle">Examples</h4><p id="waf_02_0032__p1716833174020"><strong id="waf_02_0032__b5552352124319">policy_2</strong> applying to domain IDs <strong id="waf_02_0032__b4553125234311">de06e61829494691b51979b9a03d5dcb</strong> and <strong id="waf_02_0032__b1855320524431">563972cc974b43848c73ed1a86268136</strong> is used as an example.</p>
<ul id="waf_02_0032__ul6135142618411"><li id="waf_02_0032__li18135172610412">Request example<pre class="screen" id="waf_02_0032__screen1613518266419">{
"hosts": [
"de06e61829494691b51979b9a03d5dcb",
"563972cc974b43848c73ed1a86268136"
]
}</pre>
</li></ul>
<ul id="waf_02_0032__ul14136132614112"><li id="waf_02_0032__li0136182634118">Response example<pre class="screen" id="waf_02_0032__screen10136102617414">{
"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": ["de06e61829494691b51979b9a03d5dcb", "563972cc974b43848c73ed1a86268136"],
"timestamp": 1499817612
}</pre>
</li></ul>
</div>
<div class="section" id="waf_02_0032__section40449024"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0032__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0032__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 6</a> describes the normal status code returned by the API.
<div class="tablenoborder"><a name="waf_02_0032__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0032__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_0032__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_0032__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_0032__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_0032__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0032__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_0032__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_0032__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_0032__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="waf_02_0032__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>