yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
fix_python
doc-exports/docs/cfw/api-ref/ChangeIpsSwitchStatus.html
qiaoli 9776db0ee8 First version of the CFW API 
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qiaoli <qiaoli@huawei.com>
Co-committed-by: qiaoli <qiaoli@huawei.com>
2025-01-21 07:59:01 +00:00

239 lines
18 KiB
HTML
Raw Permalink Blame History

<a name="ChangeIpsSwitchStatus"></a><a name="ChangeIpsSwitchStatus"></a>
<h1 class="topictitle1">Changing the IPS Feature Status</h1>
<div id="body1708331107508"><div class="section" id="ChangeIpsSwitchStatus__section18174164910324"><h4 class="sectiontitle">Function</h4><p id="ChangeIpsSwitchStatus__p191749496325">This API is used to enable or disable the feature.</p>
</div>
<div class="section" id="ChangeIpsSwitchStatus__section111761849133212"><h4 class="sectiontitle">URI</h4><p id="ChangeIpsSwitchStatus__p11771549193212">POST /v1/{project_id}/ips/switch</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ChangeIpsSwitchStatus__table417894914323" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ChangeIpsSwitchStatus__row2017704919328"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ChangeIpsSwitchStatus__p01789496323">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ChangeIpsSwitchStatus__p161792499327">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ChangeIpsSwitchStatus__p17179449143219">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ChangeIpsSwitchStatus__p19180349173216">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeIpsSwitchStatus__row1817704913321"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ChangeIpsSwitchStatus__p1018094973219">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ChangeIpsSwitchStatus__p9181449153211">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ChangeIpsSwitchStatus__p15181349113212">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ChangeIpsSwitchStatus__p418213498323">Project ID, which can be obtained by calling an API or from the console. For details, see <a href="cfw_02_0015.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ChangeIpsSwitchStatus__table8183114973213" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ChangeIpsSwitchStatus__row91821349103214"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ChangeIpsSwitchStatus__p11833498321">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ChangeIpsSwitchStatus__p1318414916325">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ChangeIpsSwitchStatus__p318444910326">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ChangeIpsSwitchStatus__p20185184919325">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeIpsSwitchStatus__row1318219496322"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ChangeIpsSwitchStatus__p318594911327">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ChangeIpsSwitchStatus__p418694983215">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ChangeIpsSwitchStatus__p8186154973214">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ChangeIpsSwitchStatus__p1918794910322">Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to <a href="cfw_02_0027.html">Obtaining an Enterprise Project ID</a>. If the enterprise project function is not enabled, the value is <strong id="ChangeIpsSwitchStatus__b131871649143210">0</strong>.</p>
</td>
</tr>
<tr id="ChangeIpsSwitchStatus__row31821249153218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ChangeIpsSwitchStatus__p9188149133213">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ChangeIpsSwitchStatus__p018810497328">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ChangeIpsSwitchStatus__p191898493320">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ChangeIpsSwitchStatus__p13189164914322">Firewall ID, which can be obtained by referring to <a href="cfw_02_0028.html">Obtaining a Firewall ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ChangeIpsSwitchStatus__section181901649163219"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ChangeIpsSwitchStatus__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ChangeIpsSwitchStatus__row41901149173214"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ChangeIpsSwitchStatus__p1419119490329">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ChangeIpsSwitchStatus__p1192549163211">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ChangeIpsSwitchStatus__p12192749143212">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ChangeIpsSwitchStatus__p1119311499323">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeIpsSwitchStatus__row7190149173220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ChangeIpsSwitchStatus__p1819419492326">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ChangeIpsSwitchStatus__p1819413496328">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ChangeIpsSwitchStatus__p8195649133210">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ChangeIpsSwitchStatus__p619511490321">User token. You can obtain the token by referring to <a href="cfw_02_0029.html">Obtaining a User Token</a>.</p>
</td>
</tr>
<tr id="ChangeIpsSwitchStatus__row1326818573315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ChangeIpsSwitchStatus__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ChangeIpsSwitchStatus__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ChangeIpsSwitchStatus__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ChangeIpsSwitchStatus__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ChangeIpsSwitchStatus__request_IpsSwitchDTO" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request body parameters</caption><thead align="left"><tr id="ChangeIpsSwitchStatus__row181966493324"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ChangeIpsSwitchStatus__p201973494329">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ChangeIpsSwitchStatus__p1619754917324">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ChangeIpsSwitchStatus__p19198144953213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ChangeIpsSwitchStatus__p1019994933210">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeIpsSwitchStatus__row0196849133213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ChangeIpsSwitchStatus__p19199194915326">object_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ChangeIpsSwitchStatus__p2200649183210">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ChangeIpsSwitchStatus__p1220014913322">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ChangeIpsSwitchStatus__p1820234923219">Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the <a href="ListFirewallDetail.html">API for querying firewall instances</a>. In the return value, find the ID in <strong id="ChangeIpsSwitchStatus__b16203134920324">data.records.protect_objects.object_id</strong> (The period [.] is used to separate different levels of objects). If the value of <strong id="ChangeIpsSwitchStatus__b820344943219">type</strong> is <strong id="ChangeIpsSwitchStatus__b16203194963220">0</strong>, the protected object ID belongs to the Internet border. If the value of <strong id="ChangeIpsSwitchStatus__b172031449183218">type</strong> is <strong id="ChangeIpsSwitchStatus__b62039498324">1</strong>, the protected object ID belongs to the VPC border. Here, a protected object ID whose <strong id="ChangeIpsSwitchStatus__b19203649143219">type</strong> is <strong id="ChangeIpsSwitchStatus__b1220311494327">0</strong> is used. You can obtain the value of <strong id="ChangeIpsSwitchStatus__b152033497325">type</strong> from <strong id="ChangeIpsSwitchStatus__b17203049173216">data.records.protect_objects.type</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="ChangeIpsSwitchStatus__row61964494328"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ChangeIpsSwitchStatus__p62031349123210">ips_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ChangeIpsSwitchStatus__p1020484983217">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ChangeIpsSwitchStatus__p1204194912323">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ChangeIpsSwitchStatus__p8205134953213">Patch type. Its value can only be <strong id="ChangeIpsSwitchStatus__b142051149133218">2</strong> (virtual patch).</p>
</td>
</tr>
<tr id="ChangeIpsSwitchStatus__row1119654912327"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ChangeIpsSwitchStatus__p120534913322">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ChangeIpsSwitchStatus__p12061349153212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ChangeIpsSwitchStatus__p12206749133218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ChangeIpsSwitchStatus__p16207204923214">IPS feature status: <strong id="ChangeIpsSwitchStatus__b9207549183210">0</strong> (disabled), <strong id="ChangeIpsSwitchStatus__b13207149113211">1</strong> (enabled).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ChangeIpsSwitchStatus__section102081449153210"><h4 class="sectiontitle">Response Parameters</h4><p id="ChangeIpsSwitchStatus__p62091749203219"><strong id="ChangeIpsSwitchStatus__b920918496321">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ChangeIpsSwitchStatus__response_CommonResponseDTO" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ChangeIpsSwitchStatus__row0209449203217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ChangeIpsSwitchStatus__p2021024983212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ChangeIpsSwitchStatus__p221154917326">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ChangeIpsSwitchStatus__p1521154953212">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeIpsSwitchStatus__row152095495327"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ChangeIpsSwitchStatus__p42123491329">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ChangeIpsSwitchStatus__p1721219495321"><a href="#ChangeIpsSwitchStatus__response_data">data</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ChangeIpsSwitchStatus__p152131449173218">Response body.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ChangeIpsSwitchStatus__response_data"></a><a name="response_data"></a><table cellpadding="4" cellspacing="0" summary="" id="ChangeIpsSwitchStatus__response_data" frame="border" border="1" rules="all"><caption><b>Table 6 </b>data</caption><thead align="left"><tr id="ChangeIpsSwitchStatus__row122138497323"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ChangeIpsSwitchStatus__p8214549173218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ChangeIpsSwitchStatus__p42155492321">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ChangeIpsSwitchStatus__p3215449103211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeIpsSwitchStatus__row321364993210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ChangeIpsSwitchStatus__p321684963215">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ChangeIpsSwitchStatus__p221644923219">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ChangeIpsSwitchStatus__p16217144917329">ID information.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ChangeIpsSwitchStatus__section621884953215"><h4 class="sectiontitle">Example Requests</h4><p id="ChangeIpsSwitchStatus__p1421854912322">Enable or disable the basic patch and virtual patch of the engine on the user side. The following example shows how to enable the basic patch function for protected object 1530de8a-522d-4771-9067-9fa4e2f53b48 whose project ID is 14181c1245cf4fd786824efe1e2b9388.</p>
<pre class="screen" id="ChangeIpsSwitchStatus__screen13219349173219">https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&amp;enterprise_project_id=default
{
"ips_type" : 1,
"object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48",
"status" : 1
}</pre>
</div>
<div class="section" id="ChangeIpsSwitchStatus__section112228492320"><h4 class="sectiontitle">Example Responses</h4><p id="ChangeIpsSwitchStatus__p82221649143214"><strong id="ChangeIpsSwitchStatus__b022294983217">Status code: 200</strong></p>
<p id="ChangeIpsSwitchStatus__p1922313497329">Return value for changing the IPS feature status.</p>
<pre class="screen" id="ChangeIpsSwitchStatus__screen02241849173218">{
"data" : {
"id" : "1530de8a-522d-4771-9067-9fa4e2f53b48"
}
}</pre>
</div>
<div class="section" id="ChangeIpsSwitchStatus__section3389174913217"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ChangeIpsSwitchStatus__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ChangeIpsSwitchStatus__row5283164963212"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ChangeIpsSwitchStatus__p173891049143211">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ChangeIpsSwitchStatus__p13389104993213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeIpsSwitchStatus__row328324920322"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ChangeIpsSwitchStatus__p338954923216">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ChangeIpsSwitchStatus__p1389144913324">Return value for changing the IPS feature status.</p>
</td>
</tr>
<tr id="ChangeIpsSwitchStatus__row1228324915322"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ChangeIpsSwitchStatus__p153891249173215">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ChangeIpsSwitchStatus__p0390049153212">Unauthorized</p>
</td>
</tr>
<tr id="ChangeIpsSwitchStatus__row132832497322"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ChangeIpsSwitchStatus__p12390164973216">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ChangeIpsSwitchStatus__p1739014498327">Forbidden</p>
</td>
</tr>
<tr id="ChangeIpsSwitchStatus__row1128316493320"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ChangeIpsSwitchStatus__p4390549163219">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ChangeIpsSwitchStatus__p133901649193211">Not Found</p>
</td>
</tr>
<tr id="ChangeIpsSwitchStatus__row1228317492324"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ChangeIpsSwitchStatus__p123901249193210">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ChangeIpsSwitchStatus__p1639115493327">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ChangeIpsSwitchStatus__section439115495328"><h4 class="sectiontitle">Error Codes</h4><p id="ChangeIpsSwitchStatus__p133911349183219">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000007.html">IPS management</a></div>
</div>
</div>
View Git Blame Copy Permalink