forked from docs/doc-exports
gtema
4cfecba474
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com> Co-authored-by: gtema <artem.goncharov@gmail.com> Co-committed-by: gtema <artem.goncharov@gmail.com>
201 lines
15 KiB
HTML
201 lines
15 KiB
HTML
<a name="vpc_ipv6_0004"></a><a name="vpc_ipv6_0004"></a>
|
|
|
|
<h1 class="topictitle1">Updating a Floating IP Address</h1>
|
|
<div id="body1504516740919"><div class="section" id="vpc_ipv6_0004__section937595992415"><h4 class="sectiontitle">Function</h4><p id="vpc_ipv6_0004__p11590159192415">This API is used to update a specific floating IP address and the port associated with the IP address. If <strong id="vpc_ipv6_0004__b1071310351583">port_id</strong> is left blank, the floating IP address has been unbound from the port.</p>
|
|
<p id="vpc_ipv6_0004__p3585831990">Restrictions</p>
|
|
<p id="vpc_ipv6_0004__p9591165916248">When you bind a floating IP address, if the floating IP address is in the <strong id="vpc_ipv6_0004__b842352706195349">error</strong> state, try unbinding the address first.</p>
|
|
<p id="vpc_ipv6_0004__p9591175942413">You are not allowed to bind a floating IP address that has been bound to a port to another port. You must first unbind the IP address from its original port and bind it to the required port.</p>
|
|
</div>
|
|
<div class="section" id="vpc_ipv6_0004__section1037655913249"><h4 class="sectiontitle">URI</h4><p id="vpc_ipv6_0004__p4621929886">PUT /v2.0/eip/floatingips_v6/{floatingip_id}</p>
|
|
</div>
|
|
<div class="section" id="vpc_ipv6_0004__section5385259162414"><h4 class="sectiontitle">Request Message</h4><ul id="vpc_ipv6_0004__ul03981914231"><li id="vpc_ipv6_0004__li1539816118237">Request parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_ipv6_0004__table14386115942419" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="vpc_ipv6_0004__row1559165992415"><th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="vpc_ipv6_0004__p65917591245">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.659999999999998%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="vpc_ipv6_0004__p559185992415">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.310000000000002%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="vpc_ipv6_0004__p205911159152411"><strong id="vpc_ipv6_0004__b84235270615219">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.64%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="vpc_ipv6_0004__p6591115942414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_ipv6_0004__row159211597245"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpc_ipv6_0004__p75923592248">floatingip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpc_ipv6_0004__p18592559172418"><a href="#vpc_ipv6_0004__table547993685510">floatingip</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.310000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpc_ipv6_0004__p25921159132414">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.64%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpc_ipv6_0004__p1759245922417">Specifies the floating IP address list. For details, see <a href="#vpc_ipv6_0004__table547993685510">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_ipv6_0004__table547993685510"></a><a name="table547993685510"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_ipv6_0004__table547993685510" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="vpc_ipv6_0004__b16850123612576">floatingip</strong> objects</caption><thead align="left"><tr id="vpc_ipv6_0004__row966719362553"><th align="left" class="cellrowborder" valign="top" width="19.878012198780123%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="vpc_ipv6_0004__p0685313416"><strong id="vpc_ipv6_0004__b1047913918573">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.938706129387059%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="vpc_ipv6_0004__p768561134110"><strong id="vpc_ipv6_0004__b16443144095716">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.84871512848715%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="vpc_ipv6_0004__p368681134120"><strong id="vpc_ipv6_0004__b199131741105711">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.334566543345666%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="vpc_ipv6_0004__p668612124119"><strong id="vpc_ipv6_0004__b1998164325720">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_ipv6_0004__row1667163613554"><td class="cellrowborder" valign="top" width="19.878012198780123%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpc_ipv6_0004__p1868717104113">port_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.938706129387059%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpc_ipv6_0004__p26871119419">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.84871512848715%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpc_ipv6_0004__p66889116414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.334566543345666%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpc_ipv6_0004__p14688213413">Specifies the port ID. </p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="vpc_ipv6_0004__li1663751419230">Example request 1 (Binding to a port)<pre class="screen" id="vpc_ipv6_0004__screen155931459142411">PUT https://{Endpoint}/v2.0/eip/floatingips_v6/b639c937-4737-4107-8978-fecc7327a5ae
|
|
|
|
{
|
|
"floatingip": {
|
|
"port_id": "21b5c483-84e9-40a1-86b3-3041606106f5",
|
|
"fixed_ip_address": "10.0.2.2"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="vpc_ipv6_0004__ul123221046162315"><li id="vpc_ipv6_0004__li432215469239">Example request 2 (Unbinding from a port)<pre class="screen" id="vpc_ipv6_0004__screen4724909115210">PUT https://{Endpoint}/v2.0/eip/floatingips_v6/3870858f-91dc-489f-92a1-c04dbdc6d781
|
|
|
|
{
|
|
"floatingip": {
|
|
"port_id": null
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="vpc_ipv6_0004__section183951559182418"><h4 class="sectiontitle">Response Message</h4><ul id="vpc_ipv6_0004__ul19163122142415"><li id="vpc_ipv6_0004__li216392112418">Response parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_ipv6_0004__table639619595248" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter</caption><thead align="left"><tr id="vpc_ipv6_0004__row18592059102412"><th align="left" class="cellrowborder" valign="top" width="21.11%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="vpc_ipv6_0004__p759210594240">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.89%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="vpc_ipv6_0004__p2592125917247">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="vpc_ipv6_0004__p1592145917246">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_ipv6_0004__row4592105910246"><td class="cellrowborder" valign="top" width="21.11%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="vpc_ipv6_0004__p1592115992411">floatingip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.89%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="vpc_ipv6_0004__p2059225912243"><a href="#vpc_ipv6_0004__table1935317341267">floatingip</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="vpc_ipv6_0004__p1593125932418">Specifies the floating IP address list. For details, see <a href="#vpc_ipv6_0004__table1935317341267">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_ipv6_0004__table1935317341267"></a><a name="table1935317341267"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_ipv6_0004__table1935317341267" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_ipv6_0004__b15916183213910">floatingip</strong> objects</caption><thead align="left"><tr id="vpc_ipv6_0004__row63486341164"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="vpc_ipv6_0004__p9993174855413"><strong id="vpc_ipv6_0004__b19349172101010">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.55185518551855%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="vpc_ipv6_0004__p16993194812541"><strong id="vpc_ipv6_0004__b02721133104">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.11481148114812%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="vpc_ipv6_0004__p99938485541"><strong id="vpc_ipv6_0004__b112779412107">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_ipv6_0004__row935017340612"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0004__p109931248105412">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55185518551855%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0004__p209935484543">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.11481148114812%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0004__p1099384811549">Specifies the floating IP address status. The value can be <strong id="vpc_ipv6_0004__b1759616711011">ACTIVE</strong>, <strong id="vpc_ipv6_0004__b3597275105">DOWN</strong>, or <strong id="vpc_ipv6_0004__b759814719103">ERROR</strong>.</p>
|
|
<ul id="vpc_ipv6_0004__ul10994124825413"><li id="vpc_ipv6_0004__li109931648125410"><strong id="vpc_ipv6_0004__b196632050181412">ACTIVE</strong> indicates that the floating IP address has been bound.</li><li id="vpc_ipv6_0004__li11994154813544"><strong id="vpc_ipv6_0004__b168791538143">ERROR</strong> indicates that the floating IP address is abnormal.</li><li id="vpc_ipv6_0004__li109940482541"><strong id="vpc_ipv6_0004__b17928855161410">DOWN</strong> indicates that the floating IP address has not been bound.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0004__row1035123410619"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0004__p6994144818541">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55185518551855%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0004__p1399416486549">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.11481148114812%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0004__p1899418480541">Specifies the floating IP address ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0004__row435118341261"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0004__p29942484542">floating_ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55185518551855%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0004__p9994348155412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.11481148114812%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0004__p8994174818549">Specifies the floating IPv6 address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0004__row73521344612"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0004__p119948483548">floating_network_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55185518551855%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0004__p89942482546">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.11481148114812%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0004__p59942486544">Specifies the external network ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0004__row1235211345615"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0004__p99954487543">router_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55185518551855%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0004__p1999574817544">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.11481148114812%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0004__p1199594812543">Specifies the ID of the belonged router.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0004__row535273416619"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0004__p399515488546">port_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55185518551855%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0004__p499534814543">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.11481148114812%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0004__p16995248135411">Specifies the port ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0004__row1835217343617"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0004__p2099514875417">fixed_ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55185518551855%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0004__p1599514484541">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.11481148114812%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0004__p6995134819542">Specifies the private IP address of the associated port.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0004__row15353534660"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0004__p139951748155418">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55185518551855%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0004__p209957480545">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.11481148114812%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0004__p10487112">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="vpc_ipv6_0004__li1960132133412">Example response 1 (Binding a specified floating IP address to a port)<pre class="screen" id="vpc_ipv6_0004__screen26824770152018">{
|
|
"floatingip": {
|
|
"router_id": "76c052d6-6a92-444c-b67d-147ee166a480",
|
|
"status": "ACTIVE",
|
|
"tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
|
|
"floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
|
|
"fixed_ip_address": "10.0.2.2",
|
|
"floating_ip_address": "cdcd:910a:2222:5498:8475:1111:c013:8096",
|
|
"port_id": "21b5c483-84e9-40a1-86b3-3041606106f5",
|
|
"id": "b639c937-4737-4107-8978-fecc7327a5ae"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="vpc_ipv6_0004__ul14399122619252"><li id="vpc_ipv6_0004__li439911267256">Example response 2 (Unbinding a specified floating IP address from a port)<pre class="screen" id="vpc_ipv6_0004__screen27968554152037">{
|
|
"floatingip": {
|
|
"floating_network_id": "809fdbbc-2e3e-426e-897c-cb632b081a72",
|
|
"router_id": null,
|
|
"fixed_ip_address": null,
|
|
"floating_ip_address": "cdcd:910a:2222:5498:8475:1111:c013:8096",
|
|
"tenant_id": "3c8c36e1520147ccbc83d2ccfbb9ab24",
|
|
"status": "ACTIVE",
|
|
"port_id": null,
|
|
"id": "3870858f-91dc-489f-92a1-c04dbdc6d781"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="vpc_ipv6_0004__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_ipv6_0004__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_ipv6_0004__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_ipv6_0004__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_ipv6_0000.html">Floating IP Address (IPv6)</a></div>
|
|
</div>
|
|
</div>
|
|
|