forked from docs/doc-exports
Artem Goncharov
3196b64bfc
move doc sources to other location Reviewed-by: OpenTelekomCloud Bot <None>
145 lines
12 KiB
HTML
145 lines
12 KiB
HTML
<a name="EN-US_TOPIC_0065820818"></a><a name="EN-US_TOPIC_0065820818"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About a Floating IP Address (Discarded)</h1>
|
|
<div id="body1499653398050"><div class="section" id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_section10293088"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p61001774">This API is used to query the details about a floating IP address based on the ID of the IP address.</p>
|
|
<p id="EN-US_TOPIC_0065820818__p165522201117">This API has been discarded. Use the API described in "Querying a Floating IP Address".</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_section25528928"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065820818__p91931944131817">GET /v2/{project_id}/os-floating-ips/{floating_ip_id}</p>
|
|
<p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p17816132418199">GET /v2.1/{project_id}/os-floating-ips/{floating_ip_id}</p>
|
|
<div class="p" id="EN-US_TOPIC_0065820818__p13144030153914"><a href="#EN-US_TOPIC_0065820818__en-us_topic_0057972673_table32475667">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065820818__en-us_topic_0057972673_table32475667"></a><a name="en-us_topic_0057972673_table32475667"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_table32475667" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_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_0065820818__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_0065820818__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_0065820818__p8497414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_row1664874"><td class="cellrowborder" valign="top" width="22.24%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_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_0065820818__en-us_topic_0057972673_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_0065820818__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_row102094505165"><td class="cellrowborder" valign="top" width="22.24%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p620919503165">floating_ip_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_0065820818__en-us_topic_0057972673_p32091350111612">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_0065820818__en-us_topic_0057972673_p2209205020164">Specifies the ID of the floating IP address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_section54577306"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065820818__p89911758740">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_section21433709"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065820818__p982510934614"><a href="#EN-US_TOPIC_0065820818__en-us_topic_0057972673_table38246063">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065820818__en-us_topic_0057972673_table38246063"></a><a name="en-us_topic_0057972673_table38246063"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_table38246063" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_row31787174"><th align="left" class="cellrowborder" valign="top" width="21.450000000000003%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0065820818__p1810134211253">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.480000000000002%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0065820818__p1076878152910">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.670000000000005%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0065820818__p88251842102518">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.400000000000006%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0065820818__p16825942112519">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_row12502218"><td class="cellrowborder" valign="top" width="21.450000000000003%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p6046746">floating_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.480000000000002%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0065820818__p137691832912">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.670000000000005%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p20024398">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.400000000000006%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p48031108">Specifies the floating IP address. For details, see <a href="#EN-US_TOPIC_0065820818__en-us_topic_0057972673_table65314517">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065820818__en-us_topic_0057972673_table65314517"></a><a name="en-us_topic_0057972673_table65314517"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_table65314517" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_b897031316622">floating_ip</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_row49408564"><th align="left" class="cellrowborder" valign="top" width="21.6%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0065820818__p83352466258">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.649999999999999%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0065820818__p41947234295">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.35%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0065820818__p103351946192513">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.4%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0065820818__p15335144615253">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_row23930149"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p59293887">fixed_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.649999999999999%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065820818__p1719422320291">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.35%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p38075525">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p34333880">Specifies a private IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_row40569470"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p64901660">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.649999999999999%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065820818__p151941523162915">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.35%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p22543082">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p64334135">Specifies the floating IP address ID in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_row42136306"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p57597629">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.649999999999999%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065820818__p019418233294">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.35%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p34896348">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p46606392">Specifies the ID of a bound ECS in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_row16804345"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p18974699">ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.649999999999999%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065820818__p1819419236299">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.35%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p60555637">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p21064308">Specifies the floating IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_row55361044"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p55059575">pool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.649999999999999%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065820818__p151941923122917">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.35%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p30640599">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_p41924012">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_0065820818__en-us_topic_0057972673_section58685656"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_screen40401777">GET https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/os-floating-ips/05f71f43-f3c9-47ef-ac8d-9f02aef66418
|
|
GET https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ips/05f71f43-f3c9-47ef-ac8d-9f02aef66418</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820818__section138011021164918"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065820818__screen58069215494">{
|
|
"floating_ip":{
|
|
"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"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_en-us_topic_0020212692_section22960139"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065820818__en-us_topic_0057972673_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>
|
|
|