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/ChangeEipStatus.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

374 lines
29 KiB
HTML
Raw Permalink Blame History

<a name="ChangeEipStatus"></a><a name="ChangeEipStatus"></a>
<h1 class="topictitle1">Enabling or Disabling EIP Protection</h1>
<div id="body1708331107508"><div class="section" id="ChangeEipStatus__section67939520286"><h4 class="sectiontitle">Function</h4><p id="ChangeEipStatus__p27931510286">This API is used to enable or disable EIP protection. After a customer purchases an EIP, the customer needs to call ListEips to synchronize EIPs asset before enabling EIP protection for the first time. The <strong id="ChangeEipStatus__b12793557288">sync</strong> field should be set to <strong id="ChangeEipStatus__b879312511287">1</strong>.</p>
</div>
<div class="section" id="ChangeEipStatus__section579314562814"><h4 class="sectiontitle">URI</h4><p id="ChangeEipStatus__p1079315582814">POST /v1/{project_id}/eip/protect</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ChangeEipStatus__table147941856287" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ChangeEipStatus__row579410592811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ChangeEipStatus__p779512520287">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ChangeEipStatus__p197951050282">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ChangeEipStatus__p1795105102819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ChangeEipStatus__p27951059280">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeEipStatus__row2794857287"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ChangeEipStatus__p379512514284">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ChangeEipStatus__p177951157281">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ChangeEipStatus__p1796252289">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ChangeEipStatus__p1679615520286">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="ChangeEipStatus__table1979785122811" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ChangeEipStatus__row11796105182819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ChangeEipStatus__p1479710572814">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ChangeEipStatus__p1679719542813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ChangeEipStatus__p1479720512811">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ChangeEipStatus__p379765162814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeEipStatus__row157960517283"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ChangeEipStatus__p47986514284">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ChangeEipStatus__p37988522815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ChangeEipStatus__p177981159288">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ChangeEipStatus__p7798451282">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="ChangeEipStatus__b1679865112815">0</strong>.</p>
</td>
</tr>
<tr id="ChangeEipStatus__row27962519280"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ChangeEipStatus__p147982520283">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ChangeEipStatus__p27991259282">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ChangeEipStatus__p1679914514286">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ChangeEipStatus__p1479915182814">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="ChangeEipStatus__section1579995152818"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ChangeEipStatus__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ChangeEipStatus__row1179913514281"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ChangeEipStatus__p18008510287">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ChangeEipStatus__p380016512811">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ChangeEipStatus__p780010532810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ChangeEipStatus__p780015511288">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeEipStatus__row0799195182812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ChangeEipStatus__p19800125102812">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ChangeEipStatus__p1380085122814">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ChangeEipStatus__p48006512288">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ChangeEipStatus__p138002502812">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="ChangeEipStatus__row1188973016288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ChangeEipStatus__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ChangeEipStatus__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ChangeEipStatus__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ChangeEipStatus__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="ChangeEipStatus__request_EipOperateProtectReq" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request body parameters</caption><thead align="left"><tr id="ChangeEipStatus__row1280110518286"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ChangeEipStatus__p1801958286">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ChangeEipStatus__p198011054287">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ChangeEipStatus__p9801115182812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ChangeEipStatus__p128011856285">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeEipStatus__row1880135132813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ChangeEipStatus__p14802151285">object_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ChangeEipStatus__p1280295152814">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ChangeEipStatus__p1880225122817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ChangeEipStatus__p28027592818">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="ChangeEipStatus__b198025511285">data.records.protect_objects.object_id</strong> (The period [.] is used to separate different levels of objects). If the value of <strong id="ChangeEipStatus__b19802105112816">type</strong> is <strong id="ChangeEipStatus__b380285152815">0</strong>, the protected object ID belongs to the Internet border. If the value of <strong id="ChangeEipStatus__b1580214515282">type</strong> is <strong id="ChangeEipStatus__b680219542810">1</strong>, the protected object ID belongs to the VPC border. Here, a protected object ID whose <strong id="ChangeEipStatus__b1180220522812">type</strong> is <strong id="ChangeEipStatus__b11802552289">0</strong> is used. You can obtain the value of <strong id="ChangeEipStatus__b080212514288">type</strong> from <strong id="ChangeEipStatus__b08021952287">data.records.protect_objects.type</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="ChangeEipStatus__row88019516289"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ChangeEipStatus__p198021752285">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ChangeEipStatus__p58026516286">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ChangeEipStatus__p880215152812">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ChangeEipStatus__p2080312532817">Status that an EIP will be changed to: <strong id="ChangeEipStatus__b148031758289">0</strong> (protected), <strong id="ChangeEipStatus__b148035532814">1</strong> (unprotected).</p>
</td>
</tr>
<tr id="ChangeEipStatus__row1580175112814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ChangeEipStatus__p158031356284">ip_infos</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ChangeEipStatus__p178031253288">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ChangeEipStatus__p580315182811">Array of <a href="#ChangeEipStatus__request_ip_infos">ip_infos</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ChangeEipStatus__p880395132819">List of EIPs whose protection status is changed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ChangeEipStatus__request_ip_infos"></a><a name="request_ip_infos"></a><table cellpadding="4" cellspacing="0" summary="" id="ChangeEipStatus__request_ip_infos" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ip_infos</caption><thead align="left"><tr id="ChangeEipStatus__row980316514280"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="ChangeEipStatus__p9804850286">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="ChangeEipStatus__p15804175172819">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="ChangeEipStatus__p198049522815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="ChangeEipStatus__p6805115102812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeEipStatus__row2804145162816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ChangeEipStatus__p98051453289">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ChangeEipStatus__p6805656289">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ChangeEipStatus__p280510552816">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ChangeEipStatus__p1080585112814">EIP ID, which can be obtained by calling the API for querying the EIP list. Find the value in <strong id="ChangeEipStatus__b880511513289">data.records.id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="ChangeEipStatus__row1180425182818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ChangeEipStatus__p15805459286">public_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ChangeEipStatus__p138050592820">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ChangeEipStatus__p158056510286">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ChangeEipStatus__p680535192819">EIP IPv4 address, which can be obtained by calling the API for querying the EIP list. Find the value in <strong id="ChangeEipStatus__b1380555172815">data.records.public_ip</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="ChangeEipStatus__row1180485142812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ChangeEipStatus__p118061052280">public_ipv6</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ChangeEipStatus__p1080616511282">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ChangeEipStatus__p148067562810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ChangeEipStatus__p1280645122815">EIP IPv6 address, which can be obtained by calling the API for querying the EIP list. Find the value in <strong id="ChangeEipStatus__b18806552284">data.records.public_ipv6</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ChangeEipStatus__section68064572820"><h4 class="sectiontitle">Response Parameters</h4><p id="ChangeEipStatus__p68061154289"><strong id="ChangeEipStatus__b18061051281">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ChangeEipStatus__response_ProtectEipResponse" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ChangeEipStatus__row1480614514288"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ChangeEipStatus__p9807105142814">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ChangeEipStatus__p280716582813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ChangeEipStatus__p680713592811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeEipStatus__row16806458286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ChangeEipStatus__p480785102815">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ChangeEipStatus__p7807115172811"><a href="#ChangeEipStatus__response_EIPSwitchStatusVO">EIPSwitchStatusVO</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ChangeEipStatus__p198071055289">Data returned for changing the EIP protection status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ChangeEipStatus__response_EIPSwitchStatusVO"></a><a name="response_EIPSwitchStatusVO"></a><table cellpadding="4" cellspacing="0" summary="" id="ChangeEipStatus__response_EIPSwitchStatusVO" frame="border" border="1" rules="all"><caption><b>Table 7 </b>EIPSwitchStatusVO</caption><thead align="left"><tr id="ChangeEipStatus__row1380713516282"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ChangeEipStatus__p19808653289">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ChangeEipStatus__p28085512289">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ChangeEipStatus__p3808115102815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeEipStatus__row78071517284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ChangeEipStatus__p980819510282">object_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ChangeEipStatus__p2808125202811">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ChangeEipStatus__p198081851285">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="ChangeEipStatus__b138085512817">data.records.protect_objects.object_id</strong> (The period [.] is used to separate different levels of objects). If the value of <strong id="ChangeEipStatus__b168081502817">type</strong> is <strong id="ChangeEipStatus__b080810532819">0</strong>, the protected object ID belongs to the Internet border. If the value of <strong id="ChangeEipStatus__b780835102816">type</strong> is <strong id="ChangeEipStatus__b1480814552811">1</strong>, the protected object ID belongs to the VPC border. Here, a protected object ID whose <strong id="ChangeEipStatus__b1580913552814">type</strong> is <strong id="ChangeEipStatus__b3809135202813">0</strong> is used. You can obtain the value of <strong id="ChangeEipStatus__b3809855288">type</strong> from <strong id="ChangeEipStatus__b68093532811">data.records.protect_objects.type</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="ChangeEipStatus__row08075502819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ChangeEipStatus__p88091055284">fail_eip_id_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ChangeEipStatus__p1080917542811">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ChangeEipStatus__p8809115202818">List of EIP protection statuses that fail to be modified. The status can be <strong id="ChangeEipStatus__b980914552813">successful</strong> or <strong id="ChangeEipStatus__b188094502816">fail</strong>.</p>
</td>
</tr>
<tr id="ChangeEipStatus__row16808154288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ChangeEipStatus__p480910532819">fail_eip_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ChangeEipStatus__p178098517281">Array of <a href="#ChangeEipStatus__response_FailedEipInfo">FailedEipInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ChangeEipStatus__p4809145152815">List of failures to modify the EIP protection status.</p>
</td>
</tr>
<tr id="ChangeEipStatus__row5808125192819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ChangeEipStatus__p1480910511283">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ChangeEipStatus__p68107512289">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ChangeEipStatus__p2081020510285">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 class="tablenoborder"><a name="ChangeEipStatus__response_FailedEipInfo"></a><a name="response_FailedEipInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ChangeEipStatus__response_FailedEipInfo" frame="border" border="1" rules="all"><caption><b>Table 8 </b>FailedEipInfo</caption><thead align="left"><tr id="ChangeEipStatus__row1081005182811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ChangeEipStatus__p48101542811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ChangeEipStatus__p19810125172816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ChangeEipStatus__p68112056280">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeEipStatus__row28106582820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ChangeEipStatus__p1781125142818">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ChangeEipStatus__p118111753281">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ChangeEipStatus__p48111553287">ID of an EIP whose status fails to be changed.</p>
</td>
</tr>
<tr id="ChangeEipStatus__row68100511283"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ChangeEipStatus__p118110513285">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ChangeEipStatus__p981165152820">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ChangeEipStatus__p38114517283">Error code of a status change failure.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ChangeEipStatus__p11811758284"><strong id="ChangeEipStatus__b1181111532814">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ChangeEipStatus__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ChangeEipStatus__row1681315552814"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ChangeEipStatus__p1281417515282">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ChangeEipStatus__p1781414515286">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ChangeEipStatus__p17814115142820">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeEipStatus__row1813653284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ChangeEipStatus__p15814135112811">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ChangeEipStatus__p2814657284">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ChangeEipStatus__p08141542813">Error code.</p>
</td>
</tr>
<tr id="ChangeEipStatus__row7813125102816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ChangeEipStatus__p1981416510281">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ChangeEipStatus__p4814135102812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ChangeEipStatus__p48151753281">Error description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ChangeEipStatus__section168151157280"><h4 class="sectiontitle">Example Requests</h4><ul id="ChangeEipStatus__ul1981555122818"><li id="ChangeEipStatus__li58154502813">Enable traffic protection for the EIP (1.2.3.4) whose EIP ID is 4a589be0-b40a-4694-94ff-c0710af9a0a2, project ID is 857ddec2-55f2-4503-a93a-fe70021b743c, and protected object ID is 6d3db4fd-fd58-4d8e-914b-ef91aa268f62.<pre class="screen" id="ChangeEipStatus__screen16815454282">https://{Endpoint}/v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect
{
"object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62",
"status" : 0,
"ip_infos" : [ {
"id" : "4a589be0-b40a-4694-94ff-c0710af9a0a2",
"public_ip" : "1.2.3.4"
} ]
}</pre>
</li><li id="ChangeEipStatus__li11816185102818">Disable traffic protection for the EIP (1.2.3.4) whose EIP ID is 4a589be0-b40a-4694-94ff-c0710af9a0a2, project ID is 857ddec2-55f2-4503-a93a-fe70021b743c, and protected object ID is 6d3db4fd-fd58-4d8e-914b-ef91aa268f62.<pre class="screen" id="ChangeEipStatus__screen68161655287">/v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect
{
"object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62",
"status" : 1,
"ip_infos" : [ {
"id" : "4a589be0-b40a-4694-94ff-c0710af9a0a2",
"public_ip" : "1.2.3.4"
} ]
}</pre>
</li></ul>
</div>
<div class="section" id="ChangeEipStatus__section1281715572815"><h4 class="sectiontitle">Example Responses</h4><p id="ChangeEipStatus__p6817185192815"><strong id="ChangeEipStatus__b11817956282">Status code: 200</strong></p>
<p id="ChangeEipStatus__p208177562812">Return value for enabling or disabling EIP protection.</p>
<pre class="screen" id="ChangeEipStatus__screen1181711518289">{
"data": {
"fail_eip_id_list": [],
"fail_eip_list": [],
"object_id": "ae42418e-f077-41a0-9d3b-5b2f5ad9102b",
"id": "b0a2dacc-3886-4805-838e-281653d3cd1f"
}</pre>
</div>
<div class="section" id="ChangeEipStatus__section397518514283"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ChangeEipStatus__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ChangeEipStatus__row583735162812"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ChangeEipStatus__p297505202817">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ChangeEipStatus__p5975151288">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ChangeEipStatus__row1183717516284"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ChangeEipStatus__p1797514520281">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ChangeEipStatus__p1797517514289">Return value for enabling or disabling EIP protection.</p>
</td>
</tr>
<tr id="ChangeEipStatus__row208375513289"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ChangeEipStatus__p139754510282">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ChangeEipStatus__p11975257285">Bad Request</p>
</td>
</tr>
<tr id="ChangeEipStatus__row1783775172814"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ChangeEipStatus__p497511513287">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ChangeEipStatus__p39751953282">Unauthorized</p>
</td>
</tr>
<tr id="ChangeEipStatus__row683712519286"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ChangeEipStatus__p2975145172817">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ChangeEipStatus__p597555102812">Forbidden</p>
</td>
</tr>
<tr id="ChangeEipStatus__row188371755282"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ChangeEipStatus__p897525142817">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ChangeEipStatus__p69751053285">Not Found</p>
</td>
</tr>
<tr id="ChangeEipStatus__row20837350281"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ChangeEipStatus__p697525182813">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ChangeEipStatus__p149751513281">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ChangeEipStatus__section11975105112815"><h4 class="sectiontitle">Error Codes</h4><p id="ChangeEipStatus__p1297518517289">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_300000001.html">EIP Management</a></div>
</div>
</div>
View Git Blame Copy Permalink