forked from docs/doc-exports
Artem Goncharov
3196b64bfc
move doc sources to other location Reviewed-by: OpenTelekomCloud Bot <None>
170 lines
13 KiB
HTML
170 lines
13 KiB
HTML
<a name="EN-US_TOPIC_0065820817"></a><a name="EN-US_TOPIC_0065820817"></a>
|
|
|
|
<h1 class="topictitle1">Querying Floating IP Addresses (Discarded)</h1>
|
|
<div id="body1499653398050"><div class="section" id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_section8117"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p61073976">This API is used to query floating IP addresses.</p>
|
|
<p id="EN-US_TOPIC_0065820817__p541218281120">This API has been discarded. Use the API described in "Querying Floating IP Addresses".</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_section73053"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p17816132418199">GET /v2/{project_id}/os-floating-ips</p>
|
|
<p id="EN-US_TOPIC_0065820817__p15961131815184">GET /v2.1/{project_id}/os-floating-ips</p>
|
|
<div class="p" id="EN-US_TOPIC_0065820817__p149627265357"><a href="#EN-US_TOPIC_0065820817__en-us_topic_0057972671_table32475667">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065820817__en-us_topic_0057972671_table32475667"></a><a name="en-us_topic_0057972671_table32475667"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_table32475667" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row44937496"><th align="left" class="cellrowborder" valign="top" width="22.24%" id="mcps1.3.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0065820817__p5187119">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.87%" id="mcps1.3.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0065820817__p17503500">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.88999999999999%" id="mcps1.3.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0065820817__p8497414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row1664874"><td class="cellrowborder" valign="top" width="22.24%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p637140">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p51608407">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.88999999999999%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065820817__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_section5917317"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065820817__p813317753">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_section53255854"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065820817__p15156134820362"><a href="#EN-US_TOPIC_0065820817__en-us_topic_0057972671_table49535170">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065820817__en-us_topic_0057972671_table49535170"></a><a name="en-us_topic_0057972671_table49535170"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_table49535170" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row22681099"><th align="left" class="cellrowborder" valign="top" width="18.408159184081594%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0065820817__p84761026162512">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.61833816618338%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0065820817__p4188171582412">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.86791320867913%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0065820817__p4476126202510">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.10558944105589%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0065820817__p1347632672516">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row18691797"><td class="cellrowborder" valign="top" width="18.408159184081594%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p37640571">floating_ips</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.61833816618338%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0065820817__p3188111515242">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.86791320867913%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p28987447">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.10558944105589%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p119818">Specifies the floating IP addresses.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_table9705331" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_b897031316622">floating_ip</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row25036876"><th align="left" class="cellrowborder" valign="top" width="18.608139186081388%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0065820817__p1319062962517">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.34836516348365%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0065820817__p155231117162412">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.017898210178977%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0065820817__p141906290254">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.02559744025597%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0065820817__p920632913255">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row15318330"><td class="cellrowborder" valign="top" width="18.608139186081388%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p32825243">floating_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.34836516348365%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065820817__p1452361742413">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.017898210178977%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p41599065">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.02559744025597%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p66828554">Specifies the floating IP address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_table44403789" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_b84235270693426">floating_ip</strong> attributes</caption><thead align="left"><tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row44190002"><th align="left" class="cellrowborder" valign="top" width="18.59%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0065820817__p59042316256">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.43%" id="mcps1.3.4.5.2.5.1.2"><p id="EN-US_TOPIC_0065820817__p1734022619251">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.87%" id="mcps1.3.4.5.2.5.1.3"><p id="EN-US_TOPIC_0065820817__p12904193113252">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.11%" id="mcps1.3.4.5.2.5.1.4"><p id="EN-US_TOPIC_0065820817__p16904123192516">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row43998472"><td class="cellrowborder" valign="top" width="18.59%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p7106508">fixed_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.43%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065820817__p2034092611256">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.87%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p38756276">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.11%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p4445458">Specifies a private IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row40009126"><td class="cellrowborder" valign="top" width="18.59%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p19513753">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.43%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065820817__p73401126182514">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.87%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p37110132">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.11%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p8621060">Specifies the floating IP address ID in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row10480683"><td class="cellrowborder" valign="top" width="18.59%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p43629015">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.43%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065820817__p7341102662519">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.87%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p44289360">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.11%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p1113543">Specifies the ID of a bound ECS in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row10021890"><td class="cellrowborder" valign="top" width="18.59%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p6466753">ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.43%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065820817__p1534132622515">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.87%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p54045009">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.11%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p53180163">Specifies the floating IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_row8859419"><td class="cellrowborder" valign="top" width="18.59%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p46524311">pool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.43%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0065820817__p43419267251">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.87%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p10372872">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.11%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_p8031464">Specifies the name of a network resource pool that provides floating IP addresses.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_section9540645"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_screen16466658">GET https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/os-floating-ips
|
|
GET https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ips</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820817__section716714585484"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065820817__screen817420587483">{
|
|
"floating_ips": [
|
|
{
|
|
"id": "05f71f43-f3c9-47ef-ac8d-9f02aef66418",
|
|
"pool": "external",
|
|
"ip": "10.154.51.235",
|
|
"fixed_ip": "192.168.1.2",
|
|
"instance_id": "8b380f68-5057-4aa2-a33a-170b37218fa8"
|
|
},
|
|
{
|
|
"id": "a25236cf-dd76-4adc-916a-f0b4a24048d3",
|
|
"pool": "external",
|
|
"ip": "10.154.51.237",
|
|
"fixed_ip": null,
|
|
"instance_id": null
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_en-us_topic_0020212692_section22960139"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065820817__en-us_topic_0057972671_en-us_topic_0020212692_p23670760">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0065817682.html">Floating IP Address Management (OpenStack Nova APIs)</a></div>
|
|
</div>
|
|
</div>
|
|
|