yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
406cbf6c6ffcb6d6198900cf224e77cb02ce7939
doc-exports/docs/eip/api-ref/eip_openstackapi_0006.html
fanqinying 406cbf6c6f EIP API 20251024 version 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: fanqinying <fanqinying@huawei.com>
Co-committed-by: fanqinying <fanqinying@huawei.com>
2026-04-13 19:54:24 +00:00

333 lines
38 KiB
HTML
Raw Blame History

<a name="eip_openstackapi_0006"></a><a name="eip_openstackapi_0006"></a>
<h1 class="topictitle1">Querying Floating IP Addresses</h1>
<div id="body8662426"><div class="section" id="eip_openstackapi_0006__en-us_topic_0201534068_section310981132148"><h4 class="sectiontitle">Function</h4><p id="eip_openstackapi_0006__en-us_topic_0201534068_p199711393712">This API is used to query all floating IP addresses accessible to the tenant submitting the request. </p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p849415785118">You can query the detailed information about a specified floating IP address using the API for <a href="eip_openstackapi_0007.html#eip_openstackapi_0007">Querying a Floating IP Address</a>.</p>
<div class="note" id="eip_openstackapi_0006__en-us_topic_0201534068_note3192174920480"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><div class="p" id="eip_openstackapi_0006__en-us_topic_0201534068_p39817577485">Note the following when you use EIPs of the Dedicated Load Balancer (<strong id="eip_openstackapi_0006__en-us_topic_0201534068_b207851911124910">5_gray</strong>) type:<ul id="eip_openstackapi_0006__en-us_topic_0201534068_ul18141507494"><li id="eip_openstackapi_0006__en-us_topic_0201534068_li86521438154">In <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b143161918816">eu-de</strong>, EIPs of the Dedicated Load Balancer (<strong id="eip_openstackapi_0006__en-us_topic_0201534068_b193114191781">5_gray</strong>) type cannot be assigned anymore. You can assign EIPs of the BGP (<strong id="eip_openstackapi_0006__en-us_topic_0201534068_b12311419682">5_bgp</strong>) type.</li><li id="eip_openstackapi_0006__en-us_topic_0201534068_li1194114411236">Existing EIPs of the Dedicated Load Balancer (<strong id="eip_openstackapi_0006__en-us_topic_0201534068_b1093341819529">5_gray</strong>) type can be bound to dedicated or shared load balancers.<ul id="eip_openstackapi_0006__en-us_topic_0201534068_ul2044703613155"><li id="eip_openstackapi_0006__en-us_topic_0201534068_li1222113518159">The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.</li><li id="eip_openstackapi_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_li1659819163617">You are advised to bind or unbind BGP EIPs to or from dedicated load balancers.</li></ul>
</li><li id="eip_openstackapi_0006__en-us_topic_0201534068_li1468695512506">Do not add EIPs of the dedicated load balancer type (<strong id="eip_openstackapi_0006__en-us_topic_0201534068_b153172301617">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>
<div class="section" id="eip_openstackapi_0006__en-us_topic_0201534068_section548377002148"><h4 class="sectiontitle">URI</h4><p id="eip_openstackapi_0006__en-us_topic_0201534068_p204380413711">GET /v2.0/floatingips</p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p17789155311512"><a href="#eip_openstackapi_0006__en-us_topic_0201534068_table107561756154818">Table 1</a> describes the parameters.</p>
<div class="tablenoborder"><a name="eip_openstackapi_0006__en-us_topic_0201534068_table107561756154818"></a><a name="en-us_topic_0201534068_table107561756154818"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0006__en-us_topic_0201534068_table107561756154818" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="eip_openstackapi_0006__en-us_topic_0201534068_row167571556104810"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="eip_openstackapi_0006__en-us_topic_0201534068_p0685313416"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_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="eip_openstackapi_0006__en-us_topic_0201534068_p768561134110"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_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="eip_openstackapi_0006__en-us_topic_0201534068_p368681134120"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_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="eip_openstackapi_0006__en-us_topic_0201534068_p668612124119"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b1198784071014">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_openstackapi_0006__en-us_topic_0201534068_row27572562488"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p176864111411">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p136865110419">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p16861211413">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1068611114119">Specifies the floating IP address ID.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row1757105620480"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p868615164111">floating_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1468611134120">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1668716114415">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p76878124112">Specifies the floating IPv4 address.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row16757125613485"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1668781104117">floating_network_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1668731204116">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1687610411">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p14687611411">Specifies the external network ID.</p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p4687818419">You can only use fixed external network. </p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p9687151144115">You can use <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b17545134515504">GET /v2.0/networks?router:external=True</strong> or</p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p1568711118416"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b12677425124620">GET /v2.0/networks?name={floating_network}</strong> or run the <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b967818252466">neutron net-external-list</strong> command to obtain information about the external network. </p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row67574563489"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p106871419413">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1268712115416">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p6687015419">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p668714111415">Specifies the ID of the belonged router. </p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row17757155634812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1868717104113">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p26871119419">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p66889116414">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p14688213413">Specifies the port ID. </p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row1375718561481"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p868818134116">fixed_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p568817111417">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p96881617413">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1668816118413">Specifies the private IP address of the associated port.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row11758105613489"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p968813113416">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p468815111414">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p12688141154119">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p10487112">Specifies the project ID.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row15163151102"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p19997422102">limit</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p166301841183613">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p9948137183619">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p2017153116589">Specifies the number of records that will be returned on each page. The value is from 0 to 2000. The default value is 2000.</p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p125192338584"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b7164124258">limit</strong> can be used together with <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b15985310854">marker</strong>. For details, see the parameter description of <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b193281854847">marker</strong>.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row8578219101016"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p17100142191012">marker</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p863015418363">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1694813712366">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_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="eip_openstackapi_0006__en-us_topic_0201534068_p538818488578">This parameter can work together with the parameter <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b650614119446">limit</strong>.</p>
<ul id="eip_openstackapi_0006__en-us_topic_0201534068_ul12704811125810"><li id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_li325418407124">If parameters <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b736582413514">marker</strong> and <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b17435293518">limit</strong> are not passed, resource records on the first page will be returned.</li><li id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_li1923817171338">If the parameter <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b1505159195414">marker</strong> is not passed and the value of parameter <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b14146122925417">limit</strong> is set to <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b13594516546">10</strong>, the first 10 resource records will be returned.</li><li id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_li2076741203417">If the value of the parameter <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b13589356163415">marker</strong> is set to the resource ID of the 10th record and the value of parameter <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b1557415118357">limit</strong> is set to <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b10574171193511">10</strong>, the 11th to 20th resource records will be returned.</li><li id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_li108512113551">If the value of the parameter <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b9403193716543">marker</strong> is set to the resource ID of the 10th record and the parameter <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b10358823165519">limit</strong> is not passed, 11th to 2,000th resource records will be returned. The default value of <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b112010101639">limit</strong> is <strong id="eip_openstackapi_0006__en-us_topic_0201534068_en-us_topic_0201534109_b206061121438">2000</strong>.</li></ul>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row5971723121020"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p210013424100">page_reverse</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p18630184110364">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p129481337143611">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p310016420106">Specifies the page direction. The value can be <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b842352706114342">True</strong> or <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b842352706114350">False</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p694618178717">Example:</p>
<pre class="screen" id="eip_openstackapi_0006__en-us_topic_0201534068_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="eip_openstackapi_0006__en-us_topic_0201534068_section656683442148"><h4 class="sectiontitle">Request Parameters</h4><p id="eip_openstackapi_0006__en-us_topic_0201534068_p07331748516">None</p>
</div>
<div class="section" id="eip_openstackapi_0006__en-us_topic_0201534068_section236032922148"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0006__en-us_topic_0201534068_table328184742148" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="eip_openstackapi_0006__en-us_topic_0201534068_row308815332148"><th align="left" class="cellrowborder" valign="top" width="15.55%" id="mcps1.3.4.2.2.4.1.1"><p id="eip_openstackapi_0006__en-us_topic_0201534068_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="eip_openstackapi_0006__en-us_topic_0201534068_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="eip_openstackapi_0006__en-us_topic_0201534068_p608097322148">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_openstackapi_0006__en-us_topic_0201534068_row266412852148"><td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.2.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p104605152148">floatingips</p>
</td>
<td class="cellrowborder" valign="top" width="23.34%" headers="mcps1.3.4.2.2.4.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p109471238618">Array of <a href="#eip_openstackapi_0006__en-us_topic_0201534068_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="eip_openstackapi_0006__en-us_topic_0201534068_p499181352148">Specifies the floating IP address list. For details, see <a href="#eip_openstackapi_0006__en-us_topic_0201534068_table8139247714">Table 3</a>.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row5845204094319"><td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.2.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p13826463430">floatingips_links</p>
</td>
<td class="cellrowborder" valign="top" width="23.34%" headers="mcps1.3.4.2.2.4.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p12821546204317">Array of <a href="#eip_openstackapi_0006__en-us_topic_0201534068_table62331111162">floatingips_link</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="61.11%" headers="mcps1.3.4.2.2.4.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p5821246164319">Specifies the floating IP address object list. For details, see <a href="#eip_openstackapi_0006__en-us_topic_0201534068_table62331111162">Table 4</a>.</p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p1535686111217">Only when <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b435354710221">limit</strong> is used for filtering and the number of resources exceeds the value of <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b18353204718223">limit</strong> or 2000 (default value of <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b135394712227">limit</strong>), value <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b935344714224">next</strong> will be returned for <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b10353114722217">rel</strong> and a link for <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b13535475229">href</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_openstackapi_0006__en-us_topic_0201534068_table8139247714"></a><a name="en-us_topic_0201534068_table8139247714"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0006__en-us_topic_0201534068_table8139247714" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b8212957155416">floatingip</strong> objects</caption><thead align="left"><tr id="eip_openstackapi_0006__en-us_topic_0201534068_row18132240714"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.1"><p id="eip_openstackapi_0006__en-us_topic_0201534068_p101201250870"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_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="eip_openstackapi_0006__en-us_topic_0201534068_p161211850674"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_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="eip_openstackapi_0006__en-us_topic_0201534068_p41217502719"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b732864665514">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_openstackapi_0006__en-us_topic_0201534068_row2014192410713"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_p6000412319164">Specifies the floating IP address status. The value can be <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b16246154416596">ACTIVE</strong>, <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b9247144195915">DOWN</strong>, or <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b0249154485919">ERROR</strong>.</p>
<ul id="eip_openstackapi_0006__en-us_topic_0201534068_ul10603143175810"><li id="eip_openstackapi_0006__en-us_topic_0201534068_li19952124945414"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b842352706181834">DOWN</strong> indicates that the floating IP address has not been bound.</li><li id="eip_openstackapi_0006__en-us_topic_0201534068_li13389115319543"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b84235270610164">ACTIVE</strong> indicates that the floating IP address has been bound.</li><li id="eip_openstackapi_0006__en-us_topic_0201534068_li13907438154014"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b66749771144837">ERROR</strong> indicates that the floating IP address is abnormal. </li></ul>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row4141241070"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_p4121850371">Specifies the floating IP address ID.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row16518828181314"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1276893520133">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p147682350136">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p876820352133">Specifies the project ID.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row614132416712"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_p16122205017713">Specifies the floating IP address.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row115102414717"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_p16122550274">Specifies the external network ID.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row19155241277"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_p812212506713">Specifies the ID of the belonged router.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row101514247714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_p141228504716">Specifies the port ID.</p>
<div class="note" id="eip_openstackapi_0006__en-us_topic_0201534068_note01531830171810"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_openstackapi_0006__en-us_topic_0201534068_p515453014185">The value of <strong id="eip_openstackapi_0006__en-us_topic_0201534068_b752320433561">port_id</strong> is null if the EIP is bound to a dedicated load balancer.</p>
</div></div>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row3164249715"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_p1712316501972">Specifies the private IP address of the associated port.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row21662416711"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_p1597110240277">Specifies the project ID.</p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p51231950174"></p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row11176241720"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_p18223161825216">Specifies the DNS name.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row17174241670"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_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_0006__en-us_topic_0201534068_p3921230175711">Specifies the DNS domain.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row1418142410714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1953114119914">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p595318416919">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1395374115919">Specifies the time when the floating IP address was created.</p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p1232884613478">UTC time is used.</p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p2070141994713">Format: <em id="eip_openstackapi_0006__en-us_topic_0201534068_i1169023151616">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row1188246714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p139719548912">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p53971154594">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1339713549918">Specifies the time when the floating IP address was updated.</p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p876511114816">UTC time is used.</p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p137222218476">Format: <em id="eip_openstackapi_0006__en-us_topic_0201534068_i35911393172">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_openstackapi_0006__en-us_topic_0201534068_table62331111162"></a><a name="en-us_topic_0201534068_table62331111162"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0006__en-us_topic_0201534068_table62331111162" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b1291618284272">floatingips_link</strong> object</caption><thead align="left"><tr id="eip_openstackapi_0006__en-us_topic_0201534068_row1823611191619"><th align="left" class="cellrowborder" valign="top" width="23.122312231223123%" id="mcps1.3.4.4.2.4.1.1"><p id="eip_openstackapi_0006__en-us_topic_0201534068_p19231111161619"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b1695326192718">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.552555255525554%" id="mcps1.3.4.4.2.4.1.2"><p id="eip_openstackapi_0006__en-us_topic_0201534068_p112301121618"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b3737183142714">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.325132513251326%" id="mcps1.3.4.4.2.4.1.3"><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1323611171617"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b20524173214271">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_openstackapi_0006__en-us_topic_0201534068_row15260111169"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.4.4.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p192851171616">href</p>
</td>
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.4.4.2.4.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p122815111167">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.4.4.2.4.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p12813117167">Specifies the API link.</p>
</td>
</tr>
<tr id="eip_openstackapi_0006__en-us_topic_0201534068_row132891118162"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.4.4.2.4.1.1 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p1728171118161">rel</p>
</td>
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.4.4.2.4.1.2 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p42820114167">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.4.4.2.4.1.3 "><p id="eip_openstackapi_0006__en-us_topic_0201534068_p5289119162">Specifies the relationship between the API link and the API version.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="eip_openstackapi_0006__en-us_topic_0201534068_section19109163424"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="eip_openstackapi_0006__en-us_topic_0201534068_screen201091766428">GET https://{Endpoint}/v2.0/floatingips?limit=1</pre>
</div>
<div class="section" id="eip_openstackapi_0006__en-us_topic_0201534068_section2110761425"><h4 class="sectiontitle">Example Response</h4><p id="eip_openstackapi_0006__en-us_topic_0201534068_p181103619426"><strong id="eip_openstackapi_0006__en-us_topic_0201534068_b531311911201">Status code: 200</strong></p>
<p id="eip_openstackapi_0006__en-us_topic_0201534068_p15110467429">Normal response to the GET operation</p>
<pre class="screen" id="eip_openstackapi_0006__en-us_topic_0201534068_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.test.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.test.clouds.com/v2.0/floatingips.json?limit=2000&amp;marker=d445e537-bc81-4039-9c7b-f9c1f5c73c78",
"rel" : "next"
} ]
}</pre>
</div>
<div class="section" id="eip_openstackapi_0006__en-us_topic_0201534068_section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="eip_openstackapi_0006__en-us_topic_0201534068_p18112112662914">See <a href="eip_api05_0001.html#eip_api05_0001">Status Codes</a>.</p>
</div>
<div class="section" id="eip_openstackapi_0006__en-us_topic_0201534068_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="eip_openstackapi_0006__en-us_topic_0201534068_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>
View Git Blame Copy Permalink