forked from docs/doc-exports
Qin Ying, Fan
310d2d9eb1
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
177 lines
16 KiB
HTML
177 lines
16 KiB
HTML
<a name="vpc_floatingiP_0002"></a><a name="vpc_floatingiP_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Floating IP Address</h1>
|
|
<div id="body1495458211491"><div class="section" id="vpc_floatingiP_0002__section433032482159"><h4 class="sectiontitle">Function</h4><p id="vpc_floatingiP_0002__p179021902159">This API is used to query details about a specified floating IP address, including the floating IP address status, ID of the router to which the floating IP address belongs, and external network ID of the floating IP address.</p>
|
|
<div class="note" id="vpc_floatingiP_0002__note1672091317360"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><div class="p" id="vpc_floatingiP_0002__en-us_topic_0118498850_p39817577485">Note the following when you use EIPs of the Dedicated Load Balancer (<strong id="vpc_floatingiP_0002__en-us_topic_0118498850_b1958731314398">5_gray</strong>) type:<ul id="vpc_floatingiP_0002__en-us_topic_0118498850_ul18141507494"><li id="vpc_floatingiP_0002__en-us_topic_0118498850_li86521438154">In <strong id="vpc_floatingiP_0002__en-us_topic_0118498850_b126181649151714">eu-de</strong>, EIPs of the Dedicated Load Balancer (<strong id="vpc_floatingiP_0002__en-us_topic_0118498850_b108739322183">5_gray</strong>) type cannot be assigned anymore. You can assign EIPs of the BGP (<strong id="vpc_floatingiP_0002__en-us_topic_0118498850_b1874731121812">5_bgp</strong>) type.</li><li id="vpc_floatingiP_0002__en-us_topic_0118498850_li1194114411236">Existing EIPs of the Dedicated Load Balancer (<strong id="vpc_floatingiP_0002__en-us_topic_0118498850_b113526330389">5_gray</strong>) type can be bound to dedicated or shared load balancers.<ul id="vpc_floatingiP_0002__en-us_topic_0118498850_ul2044703613155"><li id="vpc_floatingiP_0002__en-us_topic_0118498850_li1222113518159">The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.</li><li id="vpc_floatingiP_0002__en-us_topic_0118498850_li1688013347356">You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see <a href="https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/binding_an_eip.html" target="_blank" rel="noopener noreferrer">Binding an EIP</a> and <a href="https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/unbinding_an_eip.html" target="_blank" rel="noopener noreferrer">Unbinding an EIP</a>.</li><li id="vpc_floatingiP_0002__en-us_topic_0118498850_li15559236131711">EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.</li><li id="vpc_floatingiP_0002__en-us_topic_0118498850_li1659819163617">You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.</li></ul>
|
|
</li><li id="vpc_floatingiP_0002__en-us_topic_0118498850_li1468695512506">Do not add EIPs of the dedicated load balancer type (<strong id="vpc_floatingiP_0002__en-us_topic_0118498850_b354915453512">5_gray</strong>) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.</li></ul>
|
|
</div>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="vpc_floatingiP_0002__section269019862159"><h4 class="sectiontitle">URI</h4><p id="vpc_floatingiP_0002__p1858521971112">GET /v2.0/floatingips/{floatingip_id}</p>
|
|
</div>
|
|
<div class="section" id="vpc_floatingiP_0002__section513321362159"><h4 class="sectiontitle">Request Message</h4><p id="vpc_floatingiP_0002__p53875185519">None</p>
|
|
</div>
|
|
<div class="section" id="vpc_floatingiP_0002__section414903182159"><h4 class="sectiontitle">Response Message</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_floatingiP_0002__table52726292159" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameter</caption><thead align="left"><tr id="vpc_floatingiP_0002__row483206142159"><th align="left" class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.3.4.2.2.4.1.1"><p id="vpc_floatingiP_0002__p216556632159">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="8.99%" id="mcps1.3.4.2.2.4.1.2"><p id="vpc_floatingiP_0002__p92783132159">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="69.66%" id="mcps1.3.4.2.2.4.1.3"><p id="vpc_floatingiP_0002__p72773912159">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_floatingiP_0002__row525977702159"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.4.2.2.4.1.1 "><p id="vpc_floatingiP_0002__p325609822159">floatingip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="8.99%" headers="mcps1.3.4.2.2.4.1.2 "><p id="vpc_floatingiP_0002__p201938822159"><a href="#vpc_floatingiP_0002__table8139247714">floatingip</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.66%" headers="mcps1.3.4.2.2.4.1.3 "><p id="vpc_floatingiP_0002__p191679172159">Specifies the floating IP address list. For details, see <a href="#vpc_floatingiP_0002__table8139247714">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_floatingiP_0002__table8139247714"></a><a name="table8139247714"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_floatingiP_0002__table8139247714" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="vpc_floatingiP_0002__b18714181195">floatingip</strong> objects</caption><thead align="left"><tr id="vpc_floatingiP_0002__row18132240714"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.1"><p id="vpc_floatingiP_0002__p101201250870"><strong id="vpc_floatingiP_0002__b883917243138">Attribute</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.2"><p id="vpc_floatingiP_0002__p161211850674"><strong id="vpc_floatingiP_0002__b116546278139">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.3"><p id="vpc_floatingiP_0002__p41217502719"><strong id="vpc_floatingiP_0002__b1350518288137">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_floatingiP_0002__row2014192410713"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p6028218019164">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p5101843519164">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p6000412319164">Specifies the floating IP address status. The value can be <strong id="vpc_floatingiP_0002__b5686832141314">ACTIVE</strong>, <strong id="vpc_floatingiP_0002__b668614321137">DOWN</strong>, or <strong id="vpc_floatingiP_0002__b668723211135">ERROR</strong>.</p>
|
|
<ul id="vpc_floatingiP_0002__ul10603143175810"><li id="vpc_floatingiP_0002__li19952124945414"><strong id="vpc_floatingiP_0002__b69115394136">DOWN</strong> indicates that the floating IP address has not been bound.</li><li id="vpc_floatingiP_0002__li13389115319543"><strong id="vpc_floatingiP_0002__b248155261312">ACTIVE</strong> indicates that the floating IP address has been bound.</li><li id="vpc_floatingiP_0002__li13907438154014"><strong id="vpc_floatingiP_0002__b1564525313138">ERROR</strong> indicates that the floating IP address is abnormal. </li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row4141241070"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p5513524919164">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p212111505713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p4121850371">Specifies the floating IP address ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row29903910157"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p1276893520133">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p147682350136">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p876820352133">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row614132416712"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p1912112509713">floating_ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p11211850072">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p16122205017713">Specifies the floating IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row115102414717"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p61223503712">floating_network_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p1812220507714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p16122550274">Specifies the external network ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row19155241277"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p201223504719">router_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p1122155015714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p812212506713">Specifies the ID of the belonged router.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row101514247714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p412218502718">port_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p612213506716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p141228504716">Specifies the port ID.</p>
|
|
<div class="note" id="vpc_floatingiP_0002__note01531830171810"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpc_floatingiP_0002__p515453014185">This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row3164249715"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p01237508720">fixed_ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p111239501770">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p1712316501972">Specifies the private IP address of the associated port.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row21662416711"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p812355018717">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p612316509712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p10487112">Specifies the project ID.</p>
|
|
<p id="vpc_floatingiP_0002__p51231950174"></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row11176241720"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p11222111885214">dns_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p122232018115215">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p18223161825216">Specifies the DNS name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row17174241670"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p492133065713">dns_domain</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p16929300573">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p3921230175711">Specifies the DNS domain.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row1418142410714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p1953114119914">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p595318416919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p1395374115919">Specifies the time when the floating IP address was created.</p>
|
|
<p id="vpc_floatingiP_0002__p1232884613478">UTC time is used.</p>
|
|
<p id="vpc_floatingiP_0002__p2070141994713">Format: <em id="vpc_floatingiP_0002__i542193342011">yyyy-MM-ddTHH:mm:ss</em></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_floatingiP_0002__row1188246714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_floatingiP_0002__p139719548912">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_floatingiP_0002__p53971154594">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_floatingiP_0002__p1339713549918">Specifies the time when the floating IP address was updated.</p>
|
|
<p id="vpc_floatingiP_0002__p876511114816">UTC time is used.</p>
|
|
<p id="vpc_floatingiP_0002__p137222218476">Format: <em id="vpc_floatingiP_0002__i149104882218">yyyy-MM-ddTHH:mm:ss</em></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_floatingiP_0002__section1023256204210"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_floatingiP_0002__screen132324611429">GET https://{Endpoint}/v2.0/floatingips/1a3a2818-d9b4-4a9c-8a19-5252c499d1cd</pre>
|
|
</div>
|
|
<div class="section" id="vpc_floatingiP_0002__section9232368429"><h4 class="sectiontitle">Example Response</h4><p id="vpc_floatingiP_0002__p162321362425"><strong id="vpc_floatingiP_0002__b1864754012201">Status code: 200</strong></p>
|
|
<pre class="screen" id="vpc_floatingiP_0002__screen1576312017476">{
|
|
"floatingip": {
|
|
"id": "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd",
|
|
"status": "DOWN",
|
|
"router_id": null,
|
|
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
|
|
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
|
|
"floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
|
|
"fixed_ip_address": null,
|
|
"floating_ip_address": "99.99.99.84",
|
|
"port_id": null,
|
|
"dns_name": "ecs-80-158-78-239",
|
|
"dns_domain": "reverse.<em id="vpc_floatingiP_0002__i17764420154715">domain-name</em>.com",
|
|
"created_at": "2017-10-19T12:21:28",
|
|
"updated_at": "2018-07-30T12:52:13"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="vpc_floatingiP_0002__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_floatingiP_0002__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_floatingiP_0002__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_floatingiP_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_floatingiP_0000.html">Floating IP Address</a></div>
|
|
</div>
|
|
</div>
|
|
|