vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpc/api-ref/vpc_floatingiP_0001.html
fanqinying 9e7606681c VPC API 20241009 version 
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: fanqinying <fanqinying@huawei.com>
Co-committed-by: fanqinying <fanqinying@huawei.com>
2024-11-21 09:26:53 +00:00

299 lines
28 KiB
HTML
Raw Blame History

<a name="vpc_floatingiP_0001"></a><a name="vpc_floatingiP_0001"></a>
<h1 class="topictitle1">Querying Floating IP Addresses</h1>
<div id="body1495458211491"><div class="section" id="vpc_floatingiP_0001__section310981132148"><h4 class="sectiontitle">Function</h4><p id="vpc_floatingiP_0001__p199711393712">This API is used to query all floating IP addresses accessible to the tenant submitting the request. </p>
<p id="vpc_floatingiP_0001__p849415785118">You can query the detailed information about a specified floating IP address using the API for <a href="vpc_floatingiP_0002.html">Querying a Floating IP Address</a>.</p>
<div class="note" id="vpc_floatingiP_0001__note3192174920480"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><div class="p" id="vpc_floatingiP_0001__p39817577485">Note the following when you use EIPs of the Dedicated Load Balancer (<strong id="vpc_floatingiP_0001__b207851911124910">5_gray</strong>) type:<ul id="vpc_floatingiP_0001__ul18141507494"><li id="vpc_floatingiP_0001__li86521438154">In <strong id="vpc_floatingiP_0001__b1135821505214">eu-de</strong>, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (<strong id="vpc_floatingiP_0001__b3358161545217">5_bgp</strong>) type.</li><li id="vpc_floatingiP_0001__li1194114411236">Existing EIPs of the Dedicated Load Balancer (<strong id="vpc_floatingiP_0001__b1093341819529">5_gray</strong>) type can be bound to dedicated or shared load balancers.<ul id="vpc_floatingiP_0001__ul2044703613155"><li id="vpc_floatingiP_0001__li1222113518159">The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.</li><li id="vpc_floatingiP_0001__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="vpc_floatingiP_0001__li15559236131711">EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.</li><li id="vpc_floatingiP_0001__li1659819163617">You are advised to bind or unbind BGP EIPs to or from dedicated load balancers.</li></ul>
</li><li id="vpc_floatingiP_0001__li1468695512506"><strong id="vpc_floatingiP_0001__b11943176165312">5_gray</strong> EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect.</li></ul>
</div>
</div></div>
</div>
<div class="section" id="vpc_floatingiP_0001__section548377002148"><h4 class="sectiontitle">URI</h4><p id="vpc_floatingiP_0001__p204380413711">GET /v2.0/floatingips</p>
<p id="vpc_floatingiP_0001__p17789155311512"><a href="#vpc_floatingiP_0001__table107561756154818">Table 1</a> describes the parameters.</p>
<div class="tablenoborder"><a name="vpc_floatingiP_0001__table107561756154818"></a><a name="table107561756154818"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_floatingiP_0001__table107561756154818" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_floatingiP_0001__row167571556104810"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="vpc_floatingiP_0001__p0685313416"><strong id="vpc_floatingiP_0001__b148411237111018">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.2"><p id="vpc_floatingiP_0001__p768561134110"><strong id="vpc_floatingiP_0001__b95571238181017">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.3"><p id="vpc_floatingiP_0001__p368681134120"><strong id="vpc_floatingiP_0001__b471793991020">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.4"><p id="vpc_floatingiP_0001__p668612124119"><strong id="vpc_floatingiP_0001__b1198784071014">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_floatingiP_0001__row27572562488"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_floatingiP_0001__p176864111411">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_floatingiP_0001__p136865110419">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_floatingiP_0001__p16861211413">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_floatingiP_0001__p1068611114119">Specifies the floating IP address ID.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row1757105620480"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_floatingiP_0001__p868615164111">floating_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_floatingiP_0001__p1468611134120">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_floatingiP_0001__p1668716114415">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_floatingiP_0001__p76878124112">Specifies the floating IPv4 address.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row16757125613485"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_floatingiP_0001__p1668781104117">floating_network_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_floatingiP_0001__p1668731204116">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_floatingiP_0001__p1687610411">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_floatingiP_0001__p14687611411">Specifies the external network ID.</p>
<p id="vpc_floatingiP_0001__p4687818419">You can only use fixed external network. </p>
<p id="vpc_floatingiP_0001__p9687151144115">You can use <strong id="vpc_floatingiP_0001__b17545134515504">GET /v2.0/networks?router:external=True</strong> or</p>
<p id="vpc_floatingiP_0001__p1568711118416"><strong id="vpc_floatingiP_0001__b12677425124620">GET /v2.0/networks?name={floating_network}</strong> or run the <strong id="vpc_floatingiP_0001__b967818252466">neutron net-external-list</strong> command to obtain information about the external network. </p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row67574563489"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_floatingiP_0001__p106871419413">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_floatingiP_0001__p1268712115416">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_floatingiP_0001__p6687015419">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_floatingiP_0001__p668714111415">Specifies the ID of the belonged router. </p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row17757155634812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_floatingiP_0001__p1868717104113">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_floatingiP_0001__p26871119419">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_floatingiP_0001__p66889116414">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_floatingiP_0001__p14688213413">Specifies the port ID. </p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row1375718561481"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_floatingiP_0001__p868818134116">fixed_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_floatingiP_0001__p568817111417">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_floatingiP_0001__p96881617413">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_floatingiP_0001__p1668816118413">Specifies the private IP address of the associated port.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row11758105613489"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_floatingiP_0001__p968813113416">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_floatingiP_0001__p468815111414">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_floatingiP_0001__p12688141154119">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_floatingiP_0001__p10487112">Specifies the project ID.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row15163151102"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_floatingiP_0001__p19997422102">limit</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_floatingiP_0001__p166301841183613">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_floatingiP_0001__p9948137183619">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_floatingiP_0001__p2017153116589">Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000.</p>
<p id="vpc_floatingiP_0001__p125192338584"><strong id="vpc_floatingiP_0001__vpc_api01_0003_b7164124258">limit</strong> can be used together with <strong id="vpc_floatingiP_0001__vpc_api01_0003_b15985310854">marker</strong>. For details, see the parameter description of <strong id="vpc_floatingiP_0001__vpc_api01_0003_b193281854847">marker</strong>.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row8578219101016"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_floatingiP_0001__p17100142191012">marker</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_floatingiP_0001__p863015418363">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_floatingiP_0001__p1694813712366">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_floatingiP_0001__p28526205175853">Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.</p>
<p id="vpc_floatingiP_0001__p538818488578">This parameter can work together with the parameter <strong id="vpc_floatingiP_0001__vpc_api01_0003_b650614119446">limit</strong>.</p>
<ul id="vpc_floatingiP_0001__ul12704811125810"><li id="vpc_floatingiP_0001__vpc_api01_0003_li325418407124">If parameters <strong id="vpc_floatingiP_0001__vpc_api01_0003_b736582413514">marker</strong> and <strong id="vpc_floatingiP_0001__vpc_api01_0003_b17435293518">limit</strong> are not passed, resource records on the first page will be returned.</li><li id="vpc_floatingiP_0001__vpc_api01_0003_li1923817171338">If the parameter <strong id="vpc_floatingiP_0001__vpc_api01_0003_b1505159195414">marker</strong> is not passed and the value of parameter <strong id="vpc_floatingiP_0001__vpc_api01_0003_b14146122925417">limit</strong> is set to <strong id="vpc_floatingiP_0001__vpc_api01_0003_b13594516546">10</strong>, the first 10 resource records will be returned.</li><li id="vpc_floatingiP_0001__vpc_api01_0003_li2076741203417">If the value of the parameter <strong id="vpc_floatingiP_0001__vpc_api01_0003_b13589356163415">marker</strong> is set to the resource ID of the 10th record and the value of parameter <strong id="vpc_floatingiP_0001__vpc_api01_0003_b1557415118357">limit</strong> is set to <strong id="vpc_floatingiP_0001__vpc_api01_0003_b10574171193511">10</strong>, the 11th to 20th resource records will be returned.</li><li id="vpc_floatingiP_0001__vpc_api01_0003_li108512113551">If the value of the parameter <strong id="vpc_floatingiP_0001__vpc_api01_0003_b9403193716543">marker</strong> is set to the resource ID of the 10th record and the parameter <strong id="vpc_floatingiP_0001__vpc_api01_0003_b10358823165519">limit</strong> is not passed, 11th to 2,000th resource records will be returned. The default value of <strong id="vpc_floatingiP_0001__vpc_api01_0003_b112010101639">limit</strong> is <strong id="vpc_floatingiP_0001__vpc_api01_0003_b206061121438">2000</strong>.</li></ul>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row5971723121020"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_floatingiP_0001__p210013424100">page_reverse</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_floatingiP_0001__p18630184110364">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_floatingiP_0001__p129481337143611">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_floatingiP_0001__p310016420106">Specifies the page direction. The value can be <strong id="vpc_floatingiP_0001__b842352706114342">True</strong> or <strong id="vpc_floatingiP_0001__b842352706114350">False</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="vpc_floatingiP_0001__p694618178717">Example:</p>
<pre class="screen" id="vpc_floatingiP_0001__screen144833252071">GET https://{Endpoint}/v2.0/floatingips?id={fip_id}&amp;router_id={router_id}&amp;floating_network_id={net_id}&amp;floating_ip_address={floating_ip}&amp;port_id={port_id}&amp;fixed_ip_address={fixed_ip}&amp;tenant_id={tenant_id}</pre>
</div>
<div class="section" id="vpc_floatingiP_0001__section656683442148"><h4 class="sectiontitle">Request Message</h4><p id="vpc_floatingiP_0001__p07331748516">None</p>
</div>
<div class="section" id="vpc_floatingiP_0001__section236032922148"><h4 class="sectiontitle">Response Message</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_floatingiP_0001__table328184742148" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_floatingiP_0001__row308815332148"><th align="left" class="cellrowborder" valign="top" width="15.55%" id="mcps1.3.4.2.2.4.1.1"><p id="vpc_floatingiP_0001__p183762202148">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.34%" id="mcps1.3.4.2.2.4.1.2"><p id="vpc_floatingiP_0001__p120788402148">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.11%" id="mcps1.3.4.2.2.4.1.3"><p id="vpc_floatingiP_0001__p608097322148">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_floatingiP_0001__row266412852148"><td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.2.2.4.1.1 "><p id="vpc_floatingiP_0001__p104605152148">floatingips</p>
</td>
<td class="cellrowborder" valign="top" width="23.34%" headers="mcps1.3.4.2.2.4.1.2 "><p id="vpc_floatingiP_0001__p109471238618">Array of <a href="#vpc_floatingiP_0001__table8139247714">floatingip</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="61.11%" headers="mcps1.3.4.2.2.4.1.3 "><p id="vpc_floatingiP_0001__p499181352148">Specifies the floating IP address list. For details, see <a href="#vpc_floatingiP_0001__table8139247714">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_floatingiP_0001__table8139247714"></a><a name="table8139247714"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_floatingiP_0001__table8139247714" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_floatingiP_0001__b8212957155416">floatingip</strong> objects</caption><thead align="left"><tr id="vpc_floatingiP_0001__row18132240714"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.1"><p id="vpc_floatingiP_0001__p101201250870"><strong id="vpc_floatingiP_0001__b679955995412">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.2"><p id="vpc_floatingiP_0001__p161211850674"><strong id="vpc_floatingiP_0001__b13646184535515">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="vpc_floatingiP_0001__p41217502719"><strong id="vpc_floatingiP_0001__b732864665514">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_floatingiP_0001__row2014192410713"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__p6028218019164">status</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0001__p5101843519164">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p6000412319164">Specifies the floating IP address status. The value can be <strong id="vpc_floatingiP_0001__b16246154416596">ACTIVE</strong>, <strong id="vpc_floatingiP_0001__b9247144195915">DOWN</strong>, or <strong id="vpc_floatingiP_0001__b0249154485919">ERROR</strong>.</p>
<ul id="vpc_floatingiP_0001__ul10603143175810"><li id="vpc_floatingiP_0001__li19952124945414"><strong id="vpc_floatingiP_0001__b842352706181834">DOWN</strong> indicates that the floating IP address has not been bound.</li><li id="vpc_floatingiP_0001__li13389115319543"><strong id="vpc_floatingiP_0001__b84235270610164">ACTIVE</strong> indicates that the floating IP address has been bound.</li><li id="vpc_floatingiP_0001__li13907438154014"><strong id="vpc_floatingiP_0001__b66749771144837">ERROR</strong> indicates that the floating IP address is abnormal. </li></ul>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row4141241070"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__p5513524919164">id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0001__p212111505713">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p4121850371">Specifies the floating IP address ID.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row16518828181314"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__p1276893520133">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0001__p147682350136">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p876820352133">Specifies the project ID.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row614132416712"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__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="vpc_floatingiP_0001__p11211850072">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p16122205017713">Specifies the floating IP address.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row115102414717"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__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="vpc_floatingiP_0001__p1812220507714">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p16122550274">Specifies the external network ID.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row19155241277"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__p201223504719">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0001__p1122155015714">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p812212506713">Specifies the ID of the belonged router.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row101514247714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__p412218502718">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0001__p612213506716">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p141228504716">Specifies the port ID.</p>
<div class="note" id="vpc_floatingiP_0001__note1198704016"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpc_floatingiP_0001__vpc_floatingip_0002_p515453014185">This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS.</p>
</div></div>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row3164249715"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__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="vpc_floatingiP_0001__p111239501770">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p1712316501972">Specifies the private IP address of the associated port.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row21662416711"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__p812355018717">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0001__p612316509712">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p1597110240277">Specifies the project ID.</p>
<p id="vpc_floatingiP_0001__p51231950174"></p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row11176241720"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__p11222111885214">dns_name</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0001__p122232018115215">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p18223161825216">Specifies the DNS name.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row17174241670"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__p492133065713">dns_domain</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0001__p16929300573">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p3921230175711">Specifies the DNS domain.</p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row1418142410714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__p1953114119914">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0001__p595318416919">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p1395374115919">Specifies the time when the floating IP address was created.</p>
<p id="vpc_floatingiP_0001__p1232884613478">UTC time is used.</p>
<p id="vpc_floatingiP_0001__p2070141994713">Format: <em id="vpc_floatingiP_0001__i1169023151616">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
<tr id="vpc_floatingiP_0001__row1188246714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0001__p139719548912">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0001__p53971154594">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0001__p1339713549918">Specifies the time when the floating IP address was updated.</p>
<p id="vpc_floatingiP_0001__p876511114816">UTC time is used.</p>
<p id="vpc_floatingiP_0001__p137222218476">Format: <em id="vpc_floatingiP_0001__i35911393172">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_floatingiP_0001__section19109163424"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_floatingiP_0001__screen201091766428">GET https://{Endpoint}/v2.0/floatingips?limit=1</pre>
</div>
<div class="section" id="vpc_floatingiP_0001__section2110761425"><h4 class="sectiontitle">Example Response</h4><p id="vpc_floatingiP_0001__p181103619426"><strong id="vpc_floatingiP_0001__b531311911201">Status code: 200</strong></p>
<p id="vpc_floatingiP_0001__p15110467429">Normal response to the GET operation</p>
<pre class="screen" id="vpc_floatingiP_0001__screen81101960426">{
"floatingips" : [ {
"id" : "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd",
"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" : "99.99.99.84",
"port_id" : null,
"dns_name" : "ecs-88-99-103-61",
"dns_domain" : "compute.clouds-dns.com.",
"created_at" : "2017-10-19T12:21:28",
"updated_at" : "2018-07-30T12:52:13"
} ],
"floatingips_links" : [ {
"href" : "https://network.region.cn-test-2.clouds.com/v2.0/floatingips.json?limit=2000&amp;marker=000a6144-5010-46f2-bf06-6a1c94477ea3&amp;page_reverse=true",
"rel" : "previous"
}, {
"href" : "https://network.region.cn-test-2.clouds.com/v2.0/floatingips.json?limit=2000&amp;marker=d445e537-bc81-4039-9c7b-f9c1f5c73c78",
"rel" : "next"
} ]
}</pre>
</div>
<div class="section" id="vpc_floatingiP_0001__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_floatingiP_0001__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="vpc_floatingiP_0001__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_floatingiP_0001__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_floatingiP_0000.html">Floating IP Address</a></div>
</div>
</div>
View Git Blame Copy Permalink