forked from docs/doc-exports
Artem Goncharov
3196b64bfc
move doc sources to other location Reviewed-by: OpenTelekomCloud Bot <None>
93 lines
7.7 KiB
HTML
93 lines
7.7 KiB
HTML
<a name="EN-US_TOPIC_0065820820"></a><a name="EN-US_TOPIC_0065820820"></a>
|
|
|
|
<h1 class="topictitle1">Querying Floating IP Address Pools (Discarded)</h1>
|
|
<div id="body1499653398050"><div class="section" id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_section7554882"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p9185002">This API is used to query floating IP address pools.</p>
|
|
<p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p12234422546">There is only one network resource pool that can be queried through this API by tenants in Open Telekom Cloud live network environment.</p>
|
|
<p id="EN-US_TOPIC_0065820820__p135117231185">This API has been discarded. Use the API described in "Querying Networks".</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_section7965739"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p1146061620560">The API parameter is as follows: router:external=True</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0065820820__screen10281121516435">GET /networks?router:external=True //Name in the result is returned.</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_section885082"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065820820__p1732913901911">GET /v2/{project_id}/os-floating-ip-pools</p>
|
|
<p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p17816132418199">GET /v2.1/{project_id}/os-floating-ip-pools</p>
|
|
<div class="p" id="EN-US_TOPIC_0065820820__p65959291499"><a href="#EN-US_TOPIC_0065820820__en-us_topic_0057972835_table32475667">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065820820__en-us_topic_0057972835_table32475667"></a><a name="en-us_topic_0057972835_table32475667"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_table32475667" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_row44937496"><th align="left" class="cellrowborder" valign="top" width="22.24%" id="mcps1.3.3.4.2.2.4.1.1"><p id="EN-US_TOPIC_0065820820__p5187119">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.87%" id="mcps1.3.3.4.2.2.4.1.2"><p id="EN-US_TOPIC_0065820820__p17503500">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.88999999999999%" id="mcps1.3.3.4.2.2.4.1.3"><p id="EN-US_TOPIC_0065820820__p8497414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_row1664874"><td class="cellrowborder" valign="top" width="22.24%" headers="mcps1.3.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p637140">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p51608407">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.88999999999999%" headers="mcps1.3.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065820820__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_section4582792"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065820820__p1214161713157">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_section41245128"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065820820__p201603159503"><a href="#EN-US_TOPIC_0065820820__en-us_topic_0057972835_table54779151">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065820820__en-us_topic_0057972835_table54779151"></a><a name="en-us_topic_0057972835_table54779151"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_table54779151" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_row21723514"><th align="left" class="cellrowborder" valign="top" width="19.18808119188081%" id="mcps1.3.5.3.2.5.1.1"><p id="EN-US_TOPIC_0065820820__p2181159142617">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.13828617138286%" id="mcps1.3.5.3.2.5.1.2"><p id="EN-US_TOPIC_0065820820__p20648171253016">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.407259274072594%" id="mcps1.3.5.3.2.5.1.3"><p id="EN-US_TOPIC_0065820820__p1418119982619">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.266373362663735%" id="mcps1.3.5.3.2.5.1.4"><p id="EN-US_TOPIC_0065820820__p1218116952619">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_row56262227"><td class="cellrowborder" valign="top" width="19.18808119188081%" headers="mcps1.3.5.3.2.5.1.1 "><p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p60946511">floating_ip_pools</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.13828617138286%" headers="mcps1.3.5.3.2.5.1.2 "><p id="EN-US_TOPIC_0065820820__p264811215307">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.407259274072594%" headers="mcps1.3.5.3.2.5.1.3 "><p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p37720384">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.5.3.2.5.1.4 "><p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p53064224">Specifies the floating IP address pool.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_row7815975"><td class="cellrowborder" valign="top" width="19.18808119188081%" headers="mcps1.3.5.3.2.5.1.1 "><p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p29114202">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.13828617138286%" headers="mcps1.3.5.3.2.5.1.2 "><p id="EN-US_TOPIC_0065820820__p764815127301">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.407259274072594%" headers="mcps1.3.5.3.2.5.1.3 "><p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p9440199">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.266373362663735%" headers="mcps1.3.5.3.2.5.1.4 "><p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_p62775401">Specifies the name of the floating IP address pool.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_section35661838"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_screen51642735">GET https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/os-floating-ip-pools
|
|
GET https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ip-pools</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820820__section96791312115012"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065820820__screen8685212165016">{
|
|
"floating_ip_pools": [
|
|
{
|
|
"name": "pool1"
|
|
},
|
|
{
|
|
"name": "pool2"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_en-us_topic_0020212692_section22960139"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065820820__en-us_topic_0057972835_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>
|
|
|