forked from docs/doc-exports
gtema
4cfecba474
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com> Co-authored-by: gtema <artem.goncharov@gmail.com> Co-committed-by: gtema <artem.goncharov@gmail.com>
128 lines
9.9 KiB
HTML
128 lines
9.9 KiB
HTML
<a name="vpc_ipv6_0002"></a><a name="vpc_ipv6_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Floating IP Address</h1>
|
|
<div id="body1504516740919"><div class="section" id="vpc_ipv6_0002__section3531165915238"><h4 class="sectiontitle">Function</h4><p id="vpc_ipv6_0002__p572875912234">This API is used to query details about a specific floating IP address accessible to the tenant submitting the request.</p>
|
|
</div>
|
|
<div class="section" id="vpc_ipv6_0002__section1853275913236"><h4 class="sectiontitle">URI</h4><p id="vpc_ipv6_0002__p6932114815710">GET /v2.0/eip/floatingips_v6/{floatingip_id}</p>
|
|
</div>
|
|
<div class="section" id="vpc_ipv6_0002__section185401459192310"><h4 class="sectiontitle">Request Message</h4><ul id="vpc_ipv6_0002__ul1350162918118"><li id="vpc_ipv6_0002__li1635022918116">Request parameter<p id="vpc_ipv6_0002__p082516554346"><a name="vpc_ipv6_0002__li1635022918116"></a><a name="li1635022918116"></a>None</p>
|
|
</li><li id="vpc_ipv6_0002__li986181723">Example request<pre class="screen" id="vpc_ipv6_0002__screen12734759162310">GET https://{Endpoint}//v2.0/eip/floatingips_v6/2dedb5e7-cb70-4e78-b50f-d88c8321d161</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_ipv6_0002__section1354175922310"><h4 class="sectiontitle">Response Message</h4><ul id="vpc_ipv6_0002__ul39251053425"><li id="vpc_ipv6_0002__li109251353528">Response parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_ipv6_0002__table854120598236" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameter</caption><thead align="left"><tr id="vpc_ipv6_0002__row14732159202314"><th align="left" class="cellrowborder" valign="top" width="21.11%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpc_ipv6_0002__p37325591234">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="8.89%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpc_ipv6_0002__p37321059132317">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpc_ipv6_0002__p873214590235">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_ipv6_0002__row973325912318"><td class="cellrowborder" valign="top" width="21.11%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpc_ipv6_0002__p197331559192314">floatingip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="8.89%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpc_ipv6_0002__p673318596231"><a href="#vpc_ipv6_0002__table870410995611">floatingip</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpc_ipv6_0002__p673315592232">Specifies the floating IP address list. For details, see <a href="#vpc_ipv6_0002__table870410995611">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_ipv6_0002__table870410995611"></a><a name="table870410995611"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_ipv6_0002__table870410995611" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="vpc_ipv6_0002__b11769153717373">floatingip</strong> objects</caption><thead align="left"><tr id="vpc_ipv6_0002__row0700189135615"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpc_ipv6_0002__p9993174855413"><strong id="vpc_ipv6_0002__b17507145211371">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.521952195219523%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpc_ipv6_0002__p16993194812541"><strong id="vpc_ipv6_0002__b8821145418376">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.14471447144714%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpc_ipv6_0002__p99938485541"><strong id="vpc_ipv6_0002__b1063157123716">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_ipv6_0002__row37012912566"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0002__p109931248105412">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.521952195219523%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0002__p209935484543">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0002__p1099384811549">Specifies the floating IP address status. The value can be <strong id="vpc_ipv6_0002__b146573175592">ACTIVE</strong>, <strong id="vpc_ipv6_0002__b7660111718599">DOWN</strong>, or <strong id="vpc_ipv6_0002__b14663111755914">ERROR</strong>.</p>
|
|
<ul id="vpc_ipv6_0002__ul10994124825413"><li id="vpc_ipv6_0002__li109931648125410"><strong id="vpc_ipv6_0002__b147921664381">ACTIVE</strong> indicates that the floating IP address has been bound.</li><li id="vpc_ipv6_0002__li11994154813544"><strong id="vpc_ipv6_0002__b29810710384">ERROR</strong> indicates that the floating IP address is abnormal.</li><li id="vpc_ipv6_0002__li109940482541"><strong id="vpc_ipv6_0002__b35439916385">DOWN</strong> indicates that the floating IP address has not been bound.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0002__row167025913568"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0002__p6994144818541">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.521952195219523%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0002__p1399416486549">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0002__p1899418480541">Specifies the floating IP address ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0002__row0702139205615"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0002__p29942484542">floating_ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.521952195219523%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0002__p9994348155412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0002__p8994174818549">Specifies the floating IPv6 address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0002__row1703179145613"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0002__p119948483548">floating_network_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.521952195219523%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0002__p89942482546">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0002__p59942486544">Specifies the external network ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0002__row17703189195616"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0002__p99954487543">router_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.521952195219523%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0002__p1999574817544">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0002__p1199594812543">Specifies the ID of the belonged router.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0002__row57031095569"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0002__p399515488546">port_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.521952195219523%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0002__p499534814543">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0002__p16995248135411">Specifies the port ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0002__row1670489145611"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0002__p2099514875417">fixed_ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.521952195219523%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0002__p1599514484541">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0002__p6995134819542">Specifies the private IP address of the associated port.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_ipv6_0002__row270409105619"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_ipv6_0002__p139951748155418">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.521952195219523%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_ipv6_0002__p209957480545">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_ipv6_0002__p10487112">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="vpc_ipv6_0002__li841473914313">Example response<pre class="screen" id="vpc_ipv6_0002__screen695010501196">{
|
|
"floatingip": {
|
|
"id": "861a4c5b-b17b-4a1d-b653-f3e95dcb3345",
|
|
"status": "DOWN",
|
|
"router_id": null,
|
|
"tenant_id": "26ae5181a416420998eb2093aaed84d9",
|
|
"project_id": "26ae5181a416420998eb2093aaed84d9",
|
|
"floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
|
|
"fixed_ip_address": null,
|
|
"floating_ip_address": "cdcd:910a:2222:5498:8475:1111:c613:16e3",
|
|
"port_id": null,
|
|
"created_at": "2019-03-26T09:52:41",
|
|
"updated_at": "2019-03-26T09:52:45"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_ipv6_0002__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_ipv6_0002__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_ipv6_0002__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_ipv6_0002__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_ipv6_0000.html">Floating IP Address (IPv6)</a></div>
|
|
</div>
|
|
</div>
|
|
|