doc-exports/docs/eip/api-ref/eip_openstackapi_0009.html
Qin Ying, Fan 65b77b76d4 EIP API 20230106 version
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2023-08-01 06:58:15 +00:00

256 lines
26 KiB
HTML

<a name="eip_openstackapi_0009"></a><a name="eip_openstackapi_0009"></a>
<h1 class="topictitle1">Updating a Floating IP Address</h1>
<div id="body8662426"><div class="section" id="eip_openstackapi_0009__en-us_topic_0201534103_section6285365021641"><h4 class="sectiontitle">Function</h4><p id="eip_openstackapi_0009__en-us_topic_0201534103_p5798086721641">This API is used to update a floating IP address.</p>
<p id="eip_openstackapi_0009__en-us_topic_0201534103_p18750182092719">During the update, the ID of the floating IP address must be provided in the URL.</p>
<p id="eip_openstackapi_0009__en-us_topic_0201534103_p11359153817433">If <strong id="eip_openstackapi_0009__en-us_topic_0201534103_b192191519172815">port_id</strong> is left blank, the floating IP address has been unbound from the port.</p>
<div class="note" id="eip_openstackapi_0009__en-us_topic_0201534103_note94649525313"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><div class="p" id="eip_openstackapi_0009__en-us_topic_0201534103_p1546417521313">This API has the following constraints:<ul id="eip_openstackapi_0009__en-us_topic_0201534103_ul1989710153417"><li id="eip_openstackapi_0009__en-us_topic_0201534103_li864643510415">If a floating IP address that you are binding is in the <strong id="eip_openstackapi_0009__en-us_topic_0201534103_b1180313094619">error</strong> state, unbind the IP address first.</li><li id="eip_openstackapi_0009__en-us_topic_0201534103_li38971515546">Do not associate a port that has a floating IP address associated to another floating IP address. You must first disassociate the port from the IP address and then associate it with another IP address.</li><li id="eip_openstackapi_0009__en-us_topic_0201534103_li1237720482415">This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer.</li><li id="eip_openstackapi_0009__en-us_topic_0201534103_li1812193815012">In <strong id="eip_openstackapi_0009__en-us_topic_0201534103_en-us_topic_0118498850_b126181649151714">eu-de</strong>, EIPs of the Dedicated Load Balancer (<strong id="eip_openstackapi_0009__en-us_topic_0201534103_en-us_topic_0118498850_b108739322183">5_gray</strong>) type cannot be assigned anymore. You can assign EIPs of the BGP (<strong id="eip_openstackapi_0009__en-us_topic_0201534103_en-us_topic_0118498850_b1874731121812">5_bgp</strong>) type.</li><li id="eip_openstackapi_0009__en-us_topic_0201534103_li0286642141814">Existing EIPs of the Dedicated Load Balancer (<strong id="eip_openstackapi_0009__en-us_topic_0201534103_en-us_topic_0118498850_b113526330389">5_gray</strong>) type can be bound to dedicated or shared load balancers.<ul id="eip_openstackapi_0009__en-us_topic_0201534103_en-us_topic_0118498850_ul2044703613155"><li id="eip_openstackapi_0009__en-us_topic_0201534103_en-us_topic_0118498850_li1222113518159">The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.</li><li id="eip_openstackapi_0009__en-us_topic_0201534103_en-us_topic_0118498850_li1688013347356">You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see <a href="https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/binding_an_eip.html" target="_blank" rel="noopener noreferrer">Binding an EIP</a> and <a href="https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/unbinding_an_eip.html" target="_blank" rel="noopener noreferrer">Unbinding an EIP</a>.</li><li id="eip_openstackapi_0009__en-us_topic_0201534103_en-us_topic_0118498850_li15559236131711">EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.</li><li id="eip_openstackapi_0009__en-us_topic_0201534103_en-us_topic_0118498850_li1659819163617">You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.</li></ul>
</li></ul>
</div>
<ul id="eip_openstackapi_0009__en-us_topic_0201534103_ul3576654625"><li id="eip_openstackapi_0009__en-us_topic_0201534103_li6204256227">Do not add EIPs of the dedicated load balancer type (<strong id="eip_openstackapi_0009__en-us_topic_0201534103_en-us_topic_0118498850_b354915453512">5_gray</strong>) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.</li></ul>
</div></div>
</div>
<div class="section" id="eip_openstackapi_0009__en-us_topic_0201534103_section5206576221641"><h4 class="sectiontitle">URI</h4><p id="eip_openstackapi_0009__en-us_topic_0201534103_p59281032181410">PUT /v2.0/floatingips/{floatingip_id}</p>
<p id="eip_openstackapi_0009__en-us_topic_0201534103_p17789155311512"><a href="#eip_openstackapi_0009__en-us_topic_0201534103_table5388109319164">Table 1</a> describes the parameters.</p>
<div class="tablenoborder"><a name="eip_openstackapi_0009__en-us_topic_0201534103_table5388109319164"></a><a name="en-us_topic_0201534103_table5388109319164"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0009__en-us_topic_0201534103_table5388109319164" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="eip_openstackapi_0009__en-us_topic_0201534103_row6462628919164"><th align="left" class="cellrowborder" valign="top" width="23.169999999999998%" id="mcps1.3.2.4.2.5.1.1"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p23806019164"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b78917553286">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.66%" id="mcps1.3.2.4.2.5.1.2"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p868823916540"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b119011056102810">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.28%" id="mcps1.3.2.4.2.5.1.3"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p1928287519164"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b180005719282">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.89%" id="mcps1.3.2.4.2.5.1.4"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p4943306019164"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b585785862817">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_openstackapi_0009__en-us_topic_0201534103_row316619519164"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.2.4.2.5.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p115515499553">floatingip_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.66%" headers="mcps1.3.2.4.2.5.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p0689103915411">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.28%" headers="mcps1.3.2.4.2.5.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p3677022419164">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p2690811319164">Specifies the floating IP address ID.</p>
<p id="eip_openstackapi_0009__en-us_topic_0201534103_p6641157838">This parameter is not required when you assign a floating IP address. This parameter is mandatory when you query, update, or delete a floating IP address.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="eip_openstackapi_0009__en-us_topic_0201534103_section2938074421641"><h4 class="sectiontitle">Request Message</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0009__en-us_topic_0201534103_table3103003021641" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="eip_openstackapi_0009__en-us_topic_0201534103_row5907300221641"><th align="left" class="cellrowborder" valign="top" width="19.59%" id="mcps1.3.3.2.2.5.1.1"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p2018384621641">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.03%" id="mcps1.3.3.2.2.5.1.2"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p2427879021641">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.4%" id="mcps1.3.3.2.2.5.1.3"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p2042494621641">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.98%" id="mcps1.3.3.2.2.5.1.4"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p4380795521641">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_openstackapi_0009__en-us_topic_0201534103_row5878350521641"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.3.2.2.5.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p6384347521641">floatingip</p>
</td>
<td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.2.2.5.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p393901021641"><a href="#eip_openstackapi_0009__en-us_topic_0201534103_table547993685510">floatingip</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="18.4%" headers="mcps1.3.3.2.2.5.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p5062438921641">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.98%" headers="mcps1.3.3.2.2.5.1.4 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p557124874610">Specifies the floating IP address list. For details, see <a href="#eip_openstackapi_0009__en-us_topic_0201534103_table547993685510">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_openstackapi_0009__en-us_topic_0201534103_table547993685510"></a><a name="en-us_topic_0201534103_table547993685510"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0009__en-us_topic_0201534103_table547993685510" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b1265149113414">floatingip</strong> objects</caption><thead align="left"><tr id="eip_openstackapi_0009__en-us_topic_0201534103_row966719362553"><th align="left" class="cellrowborder" valign="top" width="19.878012198780123%" id="mcps1.3.3.3.2.5.1.1"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p0685313416"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b14322115343414">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.938706129387059%" id="mcps1.3.3.3.2.5.1.2"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p768561134110"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b3756754163410">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.84871512848715%" id="mcps1.3.3.3.2.5.1.3"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p368681134120"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b85211556143419">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.334566543345666%" id="mcps1.3.3.3.2.5.1.4"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p668612124119"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b12100759133410">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_openstackapi_0009__en-us_topic_0201534103_row1667163613554"><td class="cellrowborder" valign="top" width="19.878012198780123%" headers="mcps1.3.3.3.2.5.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p1868717104113">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.938706129387059%" headers="mcps1.3.3.3.2.5.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p26871119419">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.84871512848715%" headers="mcps1.3.3.3.2.5.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p66889116414">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.334566543345666%" headers="mcps1.3.3.3.2.5.1.4 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p14688213413">Specifies the port ID. </p>
<p id="eip_openstackapi_0009__en-us_topic_0201534103_p15391341153912">Leaving this parameter blank does not unbind the EIP from the dedicated load balancer.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="eip_openstackapi_0009__en-us_topic_0201534103_section2485220121641"><h4 class="sectiontitle">Response Message</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0009__en-us_topic_0201534103_table6687125821641" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameter</caption><thead align="left"><tr id="eip_openstackapi_0009__en-us_topic_0201534103_row2678790321641"><th align="left" class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.3.4.2.2.4.1.1"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p2233651921641">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.11%" id="mcps1.3.4.2.2.4.1.2"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p6442759121641">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.540000000000006%" id="mcps1.3.4.2.2.4.1.3"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p5780308921641">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_openstackapi_0009__en-us_topic_0201534103_row5153866721641"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.4.2.2.4.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p1388252621641">floatingip</p>
</td>
<td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.4.2.2.4.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p5074280121641"><a href="#eip_openstackapi_0009__en-us_topic_0201534103_table8139247714">floatingip</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="59.540000000000006%" headers="mcps1.3.4.2.2.4.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p6355285621641">Specifies the floating IP address list. For details, see <a href="#eip_openstackapi_0009__en-us_topic_0201534103_table8139247714">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_openstackapi_0009__en-us_topic_0201534103_table8139247714"></a><a name="en-us_topic_0201534103_table8139247714"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0009__en-us_topic_0201534103_table8139247714" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b35144468386">floatingip</strong> objects</caption><thead align="left"><tr id="eip_openstackapi_0009__en-us_topic_0201534103_row18132240714"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.1"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p101201250870"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b4848194719387">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.2"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p161211850674"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b5423951113817">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.3"><p id="eip_openstackapi_0009__en-us_topic_0201534103_p41217502719"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b047975220387">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_openstackapi_0009__en-us_topic_0201534103_row2014192410713"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p6028218019164">status</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p5101843519164">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p6000412319164">Specifies the floating IP address status. The value can be <strong id="eip_openstackapi_0009__en-us_topic_0201534103_b347325413814">ACTIVE</strong>, <strong id="eip_openstackapi_0009__en-us_topic_0201534103_b547445453819">DOWN</strong>, or <strong id="eip_openstackapi_0009__en-us_topic_0201534103_b19474135473816">ERROR</strong>.</p>
<ul id="eip_openstackapi_0009__en-us_topic_0201534103_ul10603143175810"><li id="eip_openstackapi_0009__en-us_topic_0201534103_li19952124945414"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b148291056183815">DOWN</strong> indicates that the floating IP address has not been bound.</li><li id="eip_openstackapi_0009__en-us_topic_0201534103_li13389115319543"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b105673119392">ACTIVE</strong> indicates that the floating IP address has been bound.</li><li id="eip_openstackapi_0009__en-us_topic_0201534103_li13907438154014"><strong id="eip_openstackapi_0009__en-us_topic_0201534103_b250519383917">ERROR</strong> indicates that the floating IP address is abnormal. </li></ul>
</td>
</tr>
<tr id="eip_openstackapi_0009__en-us_topic_0201534103_row4141241070"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p5513524919164">id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p212111505713">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p4121850371">Specifies the floating IP address ID.</p>
</td>
</tr>
<tr id="eip_openstackapi_0009__en-us_topic_0201534103_row614132416712"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p1912112509713">floating_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p11211850072">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p16122205017713">Specifies the floating IP address.</p>
</td>
</tr>
<tr id="eip_openstackapi_0009__en-us_topic_0201534103_row115102414717"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p61223503712">floating_network_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p1812220507714">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p16122550274">Specifies the external network ID.</p>
</td>
</tr>
<tr id="eip_openstackapi_0009__en-us_topic_0201534103_row19155241277"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p201223504719">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p1122155015714">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p812212506713">Specifies the ID of the belonged router.</p>
</td>
</tr>
<tr id="eip_openstackapi_0009__en-us_topic_0201534103_row101514247714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p412218502718">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p612213506716">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p141228504716">Specifies the port ID.</p>
</td>
</tr>
<tr id="eip_openstackapi_0009__en-us_topic_0201534103_row3164249715"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p01237508720">fixed_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p111239501770">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p1712316501972">Specifies the private IP address of the associated port.</p>
</td>
</tr>
<tr id="eip_openstackapi_0009__en-us_topic_0201534103_row21662416711"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p812355018717">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p612316509712">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p10487112">Specifies the project ID.</p>
<p id="eip_openstackapi_0009__en-us_topic_0201534103_p51231950174"></p>
</td>
</tr>
<tr id="eip_openstackapi_0009__en-us_topic_0201534103_row11176241720"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p11222111885214">dns_name</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p122232018115215">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p18223161825216">Specifies the DNS name.</p>
</td>
</tr>
<tr id="eip_openstackapi_0009__en-us_topic_0201534103_row17174241670"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p492133065713">dns_domain</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p16929300573">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0009__en-us_topic_0201534103_p3921230175711">Specifies the DNS domain.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="eip_openstackapi_0009__en-us_topic_0201534103_section3510479621641"><h4 class="sectiontitle">Example:</h4><p id="eip_openstackapi_0009__en-us_topic_0201534103_p945842151613">Example request 1 (Binding a floating IP address to a port)</p>
<pre class="screen" id="eip_openstackapi_0009__en-us_topic_0201534103_screen124588484327">PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2
{
"floatingip": {
"port_id": "f91f5763-c5a2-4458-979d-61e48b3c3fac"
}
}</pre>
</div>
<p id="eip_openstackapi_0009__en-us_topic_0201534103_p12211183112163">Example response 1 (Binding a floating IP address to a port)</p>
<pre class="screen" id="eip_openstackapi_0009__en-us_topic_0201534103_screen28001434143313">{
"floatingip": {
"id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2",
"status": "DOWN",
"router_id": null,
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
"fixed_ip_address": "192.168.10.3",
"floating_ip_address": "88.88.215.205",
"port_id": 00587256-27e3-489b-96bf-ea80c1da4aeb,
"dns_name": "ecs-80-158-78-239",
"dns_domain": "reverse.<em id="eip_openstackapi_0009__en-us_topic_0201534103_i0227338103511">domain-name</em>.com",
"created_at": "2018-09-20T02:10:02",
"updated_at": "2018-09-20T02:10:07"
}
}</pre>
<p id="eip_openstackapi_0009__en-us_topic_0201534103_p6745148141610">Example request 2 (Unbinding a floating IP address from a port)</p>
<pre class="screen" id="eip_openstackapi_0009__en-us_topic_0201534103_screen106157424342">PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2
{
"floatingip": {
"port_id": null
}
}</pre>
<p id="eip_openstackapi_0009__en-us_topic_0201534103_p128602910171">Example response 2 (Unbinding a floating IP address from a port)</p>
<pre class="screen" id="eip_openstackapi_0009__en-us_topic_0201534103_screen1377713136353">{
"floatingip": {
"id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2",
"status": "DOWN",
"router_id": null,
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
"fixed_ip_address": null,
"floating_ip_address": "88.88.215.205",
"port_id": null,
"dns_name": "ecs-80-158-78-239",
"dns_domain": "reverse.<em id="eip_openstackapi_0009__en-us_topic_0201534103_i9378122925913">domain-name</em>.com",
"created_at": "2018-09-20T02:10:02",
"updated_at": "2018-09-20T02:10:07"
}
}</pre>
<div class="section" id="eip_openstackapi_0009__en-us_topic_0201534103_section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="eip_openstackapi_0009__en-us_topic_0201534103_p18112112662914">See <a href="eip_api05_0001.html#eip_api05_0001">Status Codes</a>.</p>
</div>
<div class="section" id="eip_openstackapi_0009__en-us_topic_0201534103_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="eip_openstackapi_0009__en-us_topic_0201534103_p7233105282813">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="eip_openstackapi_0005.html">Floating IP Address</a></div>
</div>
</div>