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>
132 lines
11 KiB
HTML
132 lines
11 KiB
HTML
<a name="waf_02_0026"></a><a name="waf_02_0026"></a>
|
|
|
|
<h1 class="topictitle1">Switching the WAF Mode</h1>
|
|
<div id="body47167056"><div class="section" id="waf_02_0026__section15884400"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0026__p62435226">This API is used to switch the WAF mode.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0026__section8741878"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0026__ul24088573"><li id="waf_02_0026__li15470567">URI format<p id="waf_02_0026__p5017376"><a name="waf_02_0026__li15470567"></a><a name="li15470567"></a>PUT /v1/{project_id}/waf/instance/{instance_id}/protect_status</p>
|
|
</li><li id="waf_02_0026__li45156385">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0026__table3754283" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0026__row34655318"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="waf_02_0026__p55617407"><strong id="waf_02_0026__b4639155012380">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="waf_02_0026__p8716124"><strong id="waf_02_0026__b10436151183817">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="waf_02_0026__p34917462"><strong id="waf_02_0026__b182942525382">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.03479652034796%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="waf_02_0026__p9742164"><strong id="waf_02_0026__b10139195310381">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0026__row50917823"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0026__p30702974">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0026__p3912954">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0026__p48513818">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0026__p37305158">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0026__row202109"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0026__p16370855">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0026__p50970898">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0026__p35002086">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0026__p16596681">Specifies the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0026__section11568039"><h4 class="sectiontitle">Request</h4><div class="p" id="waf_02_0026__p69098112364">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0026__table19385625" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0026__row16897836"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.3.2.1.2.5.1.1"><p id="waf_02_0026__p26547515"><strong id="waf_02_0026__b1295251111392">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.1.2.5.1.2"><p id="waf_02_0026__p2865139"><strong id="waf_02_0026__b1670212129396">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.1.2.5.1.3"><p id="waf_02_0026__p30749691"><strong id="waf_02_0026__b35613163396">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.03479652034796%" id="mcps1.3.3.2.1.2.5.1.4"><p id="waf_02_0026__p7697019"><strong id="waf_02_0026__b1256021712399">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0026__row19478812"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0026__p34279941">protect_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0026__p25211871">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0026__p28895698">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0026__p158432573520">Specifies the WAF mode of a domain name.</p>
|
|
<ul id="waf_02_0026__ul484375711526"><li id="waf_02_0026__li9845657165213"><strong id="waf_02_0026__b1721153022411">1</strong>: enabled.</li><li id="waf_02_0026__li168452574529"><strong id="waf_02_0026__b10833738192419">0</strong>: disabled.</li><li id="waf_02_0026__li137818374400"><strong id="waf_02_0026__b47318513114">-1</strong>: bypassed. That is, a client sends a request to the server without passing through WAF.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0026__section37003494"><h4 class="sectiontitle">Response</h4><p id="waf_02_0026__p45921224113612">Response parameters</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0026__table770611248810" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0026__row187083241980"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.4.3.2.5.1.1"><p id="waf_02_0026__p1170982412812"><strong id="waf_02_0026__b20778821259">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.3.2.5.1.2"><p id="waf_02_0026__p117110246819"><strong id="waf_02_0026__b1644972727">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.3.2.5.1.3"><p id="waf_02_0026__p197121324882"><strong id="waf_02_0026__b534779540">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.03479652034796%" id="mcps1.3.4.3.2.5.1.4"><p id="waf_02_0026__p47141224381"><strong id="waf_02_0026__b1226130538">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0026__row117157241689"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.3.2.5.1.1 "><p id="waf_02_0026__p137162024283">protect_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="waf_02_0026__p971718241281">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="waf_02_0026__p19719192415811">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.2.5.1.4 "><p id="waf_02_0026__p139422072919">Specifies the WAF mode of a domain name.</p>
|
|
<ul id="waf_02_0026__ul63951620192918"><li id="waf_02_0026__li539772011293"><strong id="waf_02_0026__b10414165014417">1</strong>: enabled.</li><li id="waf_02_0026__li11397162018298"><strong id="waf_02_0026__b1280113241202">0</strong>: disabled.</li><li id="waf_02_0026__li339922012914"><strong id="waf_02_0026__b179187537117">-1</strong>: bypassed. That is, a client sends a request to the server without passing through WAF.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0026__section1641724123619"><h4 class="sectiontitle">Examples</h4><p id="waf_02_0026__p15012318384"><strong id="waf_02_0026__b18227103912428">protect_status</strong> with a value of <strong id="waf_02_0026__b18227103915425">1</strong> is used as an example.</p>
|
|
<ul id="waf_02_0026__ul742615418369"><li id="waf_02_0026__li16426154163615">Request example<pre class="screen" id="waf_02_0026__screen14426114173614">{
|
|
"protect_status": 1
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="waf_02_0026__ul4426541163613"><li id="waf_02_0026__li1942664116367">Response example<pre class="screen" id="waf_02_0026__screen3426241153616">{
|
|
"protect_status": 1
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0026__section64595995"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0026__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0026__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 4</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0026__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0026__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_0026__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_0026__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_0026__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_0026__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0026__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_0026__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_0026__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_0026__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0026__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_0025.html">Protection Status and Domain Setup</a></div>
|
|
</div>
|
|
</div>
|
|
|