forked from docs/doc-exports
Artem Goncharov
3196b64bfc
move doc sources to other location Reviewed-by: OpenTelekomCloud Bot <None>
176 lines
15 KiB
HTML
176 lines
15 KiB
HTML
<a name="EN-US_TOPIC_0065820816"></a><a name="EN-US_TOPIC_0065820816"></a>
|
|
|
|
<h1 class="topictitle1">Assigning a Floating IP Address (Discarded)</h1>
|
|
<div id="body1499653398050"><div class="section" id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_section30936422"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p58761073">This API is used to assign a floating IP address.</p>
|
|
<p id="EN-US_TOPIC_0065820816__p89430381717">This API has been discarded. Use the API described in "Assigning a Floating IP Address".</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_section22822288"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0065820816__p25299404111">You need to obtain a network resource pool that provides floating IP addresses. To do so, run <strong id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_b17606199422">GET /v2.0/networks?router:external=True</strong> or <strong id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_b06062910425">neutron net-external-list</strong>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_section9992350"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065820816__p9777046131713">POST /v2/{project_id}/os-floating-ips</p>
|
|
<p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p17816132418199">POST /v2.1/{project_id}/os-floating-ips</p>
|
|
<div class="p" id="EN-US_TOPIC_0065820816__p1523144817247"><a href="#EN-US_TOPIC_0065820816__en-us_topic_0057972670_table32475667">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065820816__en-us_topic_0057972670_table32475667"></a><a name="en-us_topic_0057972670_table32475667"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_table32475667" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_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_0065820816__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_0065820816__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_0065820816__p8497414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row1664874"><td class="cellrowborder" valign="top" width="22.24%" headers="mcps1.3.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_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_0065820816__en-us_topic_0057972670_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_0065820816__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_section4074007"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065820816__p113551411153311"><a href="#EN-US_TOPIC_0065820816__en-us_topic_0057972670_table62287048">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065820816__en-us_topic_0057972670_table62287048"></a><a name="en-us_topic_0057972670_table62287048"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_table62287048" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row38823967"><th align="left" class="cellrowborder" valign="top" width="16.73%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p57733603">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.98%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p45910260">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.119999999999997%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p27743545">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.17%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p32634650">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row25276401"><td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p34122633">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.98%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p12469873">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.119999999999997%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p3426769">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.17%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0065820816__p993215234119">Specifies the tenant ID specified in the URI.</p>
|
|
<p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p9132882">The value is in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row15087078"><td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p14093819">pool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.98%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p748676">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.119999999999997%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p60642794">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.17%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p13119252">Specifies the network resource pool that provides floating IP addresses. If it is not specified, the default resource pool is used.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_section36666067"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065820816__p3601104383319"><a href="#EN-US_TOPIC_0065820816__en-us_topic_0057972670_table56026474">Table 3</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065820816__en-us_topic_0057972670_table56026474"></a><a name="en-us_topic_0057972670_table56026474"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_table56026474" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row18214233"><th align="left" class="cellrowborder" valign="top" width="17.691769176917692%" id="mcps1.3.5.3.2.5.1.1"><p id="EN-US_TOPIC_0065820816__p1857817110255">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.591359135913592%" id="mcps1.3.5.3.2.5.1.2"><p id="EN-US_TOPIC_0065820816__p7269121916223">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.112311231123112%" id="mcps1.3.5.3.2.5.1.3"><p id="EN-US_TOPIC_0065820816__p1557841182517">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.604560456045604%" id="mcps1.3.5.3.2.5.1.4"><p id="EN-US_TOPIC_0065820816__p8578111172512">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row11710498"><td class="cellrowborder" valign="top" width="17.691769176917692%" headers="mcps1.3.5.3.2.5.1.1 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p9026257">floating_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.591359135913592%" headers="mcps1.3.5.3.2.5.1.2 "><p id="EN-US_TOPIC_0065820816__p4269111962214">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.112311231123112%" headers="mcps1.3.5.3.2.5.1.3 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p60038205">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.604560456045604%" headers="mcps1.3.5.3.2.5.1.4 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p48740201">Specifies the floating IP address. For details, see <a href="#EN-US_TOPIC_0065820816__en-us_topic_0057972670_table55642234">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065820816__en-us_topic_0057972670_table55642234"></a><a name="en-us_topic_0057972670_table55642234"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_table55642234" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_b897031316622">floating_ip</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row53704644"><th align="left" class="cellrowborder" valign="top" width="17.948205179482056%" id="mcps1.3.5.4.2.5.1.1"><p id="EN-US_TOPIC_0065820816__p1385210153257">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.538646135386465%" id="mcps1.3.5.4.2.5.1.2"><p id="EN-US_TOPIC_0065820816__p1192152214222">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.237676232376767%" id="mcps1.3.5.4.2.5.1.3"><p id="EN-US_TOPIC_0065820816__p8852171516252">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.275472452754734%" id="mcps1.3.5.4.2.5.1.4"><p id="EN-US_TOPIC_0065820816__p485291517253">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row19737894"><td class="cellrowborder" valign="top" width="17.948205179482056%" headers="mcps1.3.5.4.2.5.1.1 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p55265559">fixed_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.538646135386465%" headers="mcps1.3.5.4.2.5.1.2 "><p id="EN-US_TOPIC_0065820816__p019232262212">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.237676232376767%" headers="mcps1.3.5.4.2.5.1.3 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p47325326">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.275472452754734%" headers="mcps1.3.5.4.2.5.1.4 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p55859239">Specifies a private IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row32971110"><td class="cellrowborder" valign="top" width="17.948205179482056%" headers="mcps1.3.5.4.2.5.1.1 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p53414263">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.538646135386465%" headers="mcps1.3.5.4.2.5.1.2 "><p id="EN-US_TOPIC_0065820816__p10192172215221">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.237676232376767%" headers="mcps1.3.5.4.2.5.1.3 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p31588048">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.275472452754734%" headers="mcps1.3.5.4.2.5.1.4 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p17016957">Specifies the floating IP address ID in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row18934887"><td class="cellrowborder" valign="top" width="17.948205179482056%" headers="mcps1.3.5.4.2.5.1.1 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p57330849">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.538646135386465%" headers="mcps1.3.5.4.2.5.1.2 "><p id="EN-US_TOPIC_0065820816__p131921922152211">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.237676232376767%" headers="mcps1.3.5.4.2.5.1.3 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p13287175">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.275472452754734%" headers="mcps1.3.5.4.2.5.1.4 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p2747002">Specifies the ID of a bound ECS in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row24723024"><td class="cellrowborder" valign="top" width="17.948205179482056%" headers="mcps1.3.5.4.2.5.1.1 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p56407950">ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.538646135386465%" headers="mcps1.3.5.4.2.5.1.2 "><p id="EN-US_TOPIC_0065820816__p7192152219224">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.237676232376767%" headers="mcps1.3.5.4.2.5.1.3 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p5641212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.275472452754734%" headers="mcps1.3.5.4.2.5.1.4 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p35008393">Specifies the floating IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_row46640084"><td class="cellrowborder" valign="top" width="17.948205179482056%" headers="mcps1.3.5.4.2.5.1.1 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p19750463">pool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.538646135386465%" headers="mcps1.3.5.4.2.5.1.2 "><p id="EN-US_TOPIC_0065820816__p81922022112215">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.237676232376767%" headers="mcps1.3.5.4.2.5.1.3 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p56283646">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.275472452754734%" headers="mcps1.3.5.4.2.5.1.4 "><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_p44033946">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_0065820816__en-us_topic_0057972670_section61559149"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0065820816__screen13452323113119">POST https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/os-floating-ips
|
|
POST https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ips</pre>
|
|
<pre class="screen" id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_screen45148491192344">{
|
|
"pool": "external"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820816__section668881316481"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065820816__screen7696101364817">{
|
|
"floating_ip": {
|
|
"id": "7aa2aa63-3097-4cfe-a2e4-596c301d3b1b",
|
|
"pool": "external",
|
|
"ip": "10.154.53.184",
|
|
"fixed_ip": null,
|
|
"instance_id": null
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_en-us_topic_0020212692_section22960139"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065820816__en-us_topic_0057972670_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>
|
|
|