doc-exports/docs/vpc/api-ref/vpc_ipv6_0001.html
Qin Ying, Fan 310d2d9eb1 VPC API 20230106 version
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>
2024-02-06 08:38:37 +00:00

227 lines
18 KiB
HTML

<a name="vpc_ipv6_0001"></a><a name="vpc_ipv6_0001"></a>
<h1 class="topictitle1">Querying Floating IP Addresses</h1>
<div id="body1504516740919"><div class="section" id="vpc_ipv6_0001__section14945458192213"><h4 class="sectiontitle">Function</h4><p id="vpc_ipv6_0001__p3954618165217">This API is used to query all floating IP addresses accessible to the tenant submitting the request.</p>
</div>
<div class="section" id="vpc_ipv6_0001__section494655812215"><h4 class="sectiontitle">URI</h4><p id="vpc_ipv6_0001__p692214367509">GET /v2.0/eip/floatingips_v6</p>
<p id="vpc_ipv6_0001__p8904401111">Example:</p>
<pre class="screen" id="vpc_ipv6_0001__screen390154012114">GET https://{Endpoint}/v2.0/eip/floatingips_v6?id={id}&amp;router_id={router_id}&amp;floating_network_id={floating_network_id}&amp;floating_ip_address={floating_ip_address}&amp;port_id={port_id }&amp;fixed_ip_address={fixed_ip_address}&amp;tenant_id={tenant_id}</pre>
<p id="vpc_ipv6_0001__p89242083912"><a href="#vpc_ipv6_0001__table668331194113">Table 1</a> describes the parameters.</p>
</div>
<div class="tablenoborder"><a name="vpc_ipv6_0001__table668331194113"></a><a name="table668331194113"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_ipv6_0001__table668331194113" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_ipv6_0001__row10685111104111"><th align="left" class="cellrowborder" valign="top" width="23.43765623437656%" id="mcps1.3.3.2.5.1.1"><p id="vpc_ipv6_0001__p0685313416"><strong id="vpc_ipv6_0001__b91094311293">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.37906209379062%" id="mcps1.3.3.2.5.1.2"><p id="vpc_ipv6_0001__p768561134110"><strong id="vpc_ipv6_0001__b5814142784412">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.43765623437656%" id="mcps1.3.3.2.5.1.3"><p id="vpc_ipv6_0001__p368681134120"><strong id="vpc_ipv6_0001__b994730174413">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.745625437456255%" id="mcps1.3.3.2.5.1.4"><p id="vpc_ipv6_0001__p668612124119"><strong id="vpc_ipv6_0001__b1313533174414">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_ipv6_0001__row3686171204116"><td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.1 "><p id="vpc_ipv6_0001__p176864111411">id</p>
</td>
<td class="cellrowborder" valign="top" width="9.37906209379062%" headers="mcps1.3.3.2.5.1.2 "><p id="vpc_ipv6_0001__p136865110419">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.3 "><p id="vpc_ipv6_0001__p16861211413">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.745625437456255%" headers="mcps1.3.3.2.5.1.4 "><p id="vpc_ipv6_0001__p1068611114119">Specifies the floating IP address ID.</p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row19686619418"><td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.1 "><p id="vpc_ipv6_0001__p868615164111">floating_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="9.37906209379062%" headers="mcps1.3.3.2.5.1.2 "><p id="vpc_ipv6_0001__p1468611134120">No</p>
</td>
<td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.3 "><p id="vpc_ipv6_0001__p1668716114415">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.745625437456255%" headers="mcps1.3.3.2.5.1.4 "><p id="vpc_ipv6_0001__p76878124112">Specifies the floating IPv6 address.</p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row126871811412"><td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.1 "><p id="vpc_ipv6_0001__p1668781104117">floating_network_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.37906209379062%" headers="mcps1.3.3.2.5.1.2 "><p id="vpc_ipv6_0001__p1668731204116">No</p>
</td>
<td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.3 "><p id="vpc_ipv6_0001__p1687610411">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.745625437456255%" headers="mcps1.3.3.2.5.1.4 "><p id="vpc_ipv6_0001__p14687611411">Specifies the external network ID.</p>
<p id="vpc_ipv6_0001__p4687818419">You can only use fixed external network. </p>
<p id="vpc_ipv6_0001__p9687151144115">You can use <strong id="vpc_ipv6_0001__b16947183205511">GET /v2.0/networks?router:external=True</strong> or</p>
<p id="vpc_ipv6_0001__p1568711118416"><strong id="vpc_ipv6_0001__b1132415435015">GET /v2.0/networks?name={floating_network}</strong> or run the <strong id="vpc_ipv6_0001__b14326354145013">neutron net-external-list</strong> command to obtain information about the external network. </p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row5687814417"><td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.1 "><p id="vpc_ipv6_0001__p106871419413">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.37906209379062%" headers="mcps1.3.3.2.5.1.2 "><p id="vpc_ipv6_0001__p1268712115416">No</p>
</td>
<td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.3 "><p id="vpc_ipv6_0001__p6687015419">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.745625437456255%" headers="mcps1.3.3.2.5.1.4 "><p id="vpc_ipv6_0001__p668714111415">Specifies the ID of the belonged router. </p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row116871516414"><td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.1 "><p id="vpc_ipv6_0001__p1868717104113">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.37906209379062%" headers="mcps1.3.3.2.5.1.2 "><p id="vpc_ipv6_0001__p26871119419">No</p>
</td>
<td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.3 "><p id="vpc_ipv6_0001__p66889116414">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.745625437456255%" headers="mcps1.3.3.2.5.1.4 "><p id="vpc_ipv6_0001__p14688213413">Specifies the port ID. </p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row1168817194115"><td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.1 "><p id="vpc_ipv6_0001__p868818134116">fixed_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="9.37906209379062%" headers="mcps1.3.3.2.5.1.2 "><p id="vpc_ipv6_0001__p568817111417">No</p>
</td>
<td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.3 "><p id="vpc_ipv6_0001__p96881617413">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.745625437456255%" headers="mcps1.3.3.2.5.1.4 "><p id="vpc_ipv6_0001__p1668816118413">Specifies the private IP address of the associated port.</p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row116884115417"><td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.1 "><p id="vpc_ipv6_0001__p968813113416">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.37906209379062%" headers="mcps1.3.3.2.5.1.2 "><p id="vpc_ipv6_0001__p468815111414">No</p>
</td>
<td class="cellrowborder" valign="top" width="23.43765623437656%" headers="mcps1.3.3.2.5.1.3 "><p id="vpc_ipv6_0001__p12688141154119">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.745625437456255%" headers="mcps1.3.3.2.5.1.4 "><p id="vpc_ipv6_0001__p10487112">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="vpc_ipv6_0001__section5957155814226"><h4 class="sectiontitle">Request Message</h4><ul id="vpc_ipv6_0001__ul34216874"><li id="vpc_ipv6_0001__li46712854">Request parameter<p id="vpc_ipv6_0001__p12345400203926"><a name="vpc_ipv6_0001__li46712854"></a><a name="li46712854"></a>None</p>
</li><li id="vpc_ipv6_0001__li5283856794326">Example request<p id="vpc_ipv6_0001__p10263903203929"><a name="vpc_ipv6_0001__li5283856794326"></a><a name="li5283856794326"></a>None</p>
</li></ul>
</div>
<div class="section" id="vpc_ipv6_0001__section2957195852214"><h4 class="sectiontitle">Response Message</h4><ul id="vpc_ipv6_0001__ul1980562511541"><li id="vpc_ipv6_0001__li1580515256549">Response parameter</li></ul>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_ipv6_0001__table395825872218" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_ipv6_0001__row15122195992213"><th align="left" class="cellrowborder" valign="top" width="15.381538153815383%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_ipv6_0001__p1612211591220">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.072307230723073%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_ipv6_0001__p7122185916226">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.546154615461546%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_ipv6_0001__p512212594226">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_ipv6_0001__row412225982219"><td class="cellrowborder" valign="top" width="15.381538153815383%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_ipv6_0001__p3122155914223">floatingips</p>
</td>
<td class="cellrowborder" valign="top" width="23.072307230723073%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_ipv6_0001__p1112214593223">Array of <a href="#vpc_ipv6_0001__table129961748135412">floatingip</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="61.546154615461546%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_ipv6_0001__p10123059152213">Specifies the floating IP address list. For details, see <a href="#vpc_ipv6_0001__table129961748135412">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_ipv6_0001__table129961748135412"></a><a name="table129961748135412"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_ipv6_0001__table129961748135412" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_ipv6_0001__b8423527068151">floatingip</strong> objects</caption><thead align="left"><tr id="vpc_ipv6_0001__row5993648185411"><th align="left" class="cellrowborder" valign="top" width="24.452445244524455%" id="mcps1.3.5.4.2.4.1.1"><p id="vpc_ipv6_0001__p9993174855413"><strong id="vpc_ipv6_0001__b727017471321">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.931793179317932%" id="mcps1.3.5.4.2.4.1.2"><p id="vpc_ipv6_0001__p16993194812541"><strong id="vpc_ipv6_0001__b146834910215">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.615761576157624%" id="mcps1.3.5.4.2.4.1.3"><p id="vpc_ipv6_0001__p99938485541"><strong id="vpc_ipv6_0001__b150314501422">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_ipv6_0001__row399444818546"><td class="cellrowborder" valign="top" width="24.452445244524455%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_ipv6_0001__p109931248105412">status</p>
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_ipv6_0001__p209935484543">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.615761576157624%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_ipv6_0001__p1099384811549">Specifies the floating IP address status. The value can be <strong id="vpc_ipv6_0001__b81252317598">ACTIVE</strong>, <strong id="vpc_ipv6_0001__b61280316597">DOWN</strong>, or <strong id="vpc_ipv6_0001__b31301031175917">ERROR</strong>.</p>
<ul id="vpc_ipv6_0001__ul10994124825413"><li id="vpc_ipv6_0001__li109931648125410"><strong id="vpc_ipv6_0001__b1416416131052">ACTIVE</strong> indicates that the floating IP address has been bound.</li><li id="vpc_ipv6_0001__li11994154813544"><strong id="vpc_ipv6_0001__b377055614519">ERROR</strong> indicates that the floating IP address is abnormal.</li><li id="vpc_ipv6_0001__li109940482541"><strong id="vpc_ipv6_0001__b165241699718">DOWN</strong> indicates that the floating IP address has not been bound.</li></ul>
</td>
</tr>
<tr id="vpc_ipv6_0001__row209948489541"><td class="cellrowborder" valign="top" width="24.452445244524455%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_ipv6_0001__p6994144818541">id</p>
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_ipv6_0001__p1399416486549">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.615761576157624%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_ipv6_0001__p1899418480541">Specifies the floating IP address ID.</p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row99941448115418"><td class="cellrowborder" valign="top" width="24.452445244524455%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_ipv6_0001__p29942484542">floating_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_ipv6_0001__p9994348155412">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.615761576157624%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_ipv6_0001__p8994174818549">Specifies the floating IPv6 address.</p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row1499474865414"><td class="cellrowborder" valign="top" width="24.452445244524455%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_ipv6_0001__p119948483548">floating_network_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_ipv6_0001__p89942482546">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.615761576157624%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_ipv6_0001__p59942486544">Specifies the external network ID.</p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row89951548125411"><td class="cellrowborder" valign="top" width="24.452445244524455%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_ipv6_0001__p99954487543">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_ipv6_0001__p1999574817544">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.615761576157624%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_ipv6_0001__p1199594812543">Specifies the ID of the belonged router.</p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row1699515482547"><td class="cellrowborder" valign="top" width="24.452445244524455%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_ipv6_0001__p399515488546">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_ipv6_0001__p499534814543">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.615761576157624%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_ipv6_0001__p16995248135411">Specifies the port ID.</p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row15995124813546"><td class="cellrowborder" valign="top" width="24.452445244524455%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_ipv6_0001__p2099514875417">fixed_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_ipv6_0001__p1599514484541">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.615761576157624%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_ipv6_0001__p6995134819542">Specifies the private IP address of the associated port.</p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row8996124875412"><td class="cellrowborder" valign="top" width="24.452445244524455%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_ipv6_0001__p139951748155418">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_ipv6_0001__p209957480545">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.615761576157624%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_ipv6_0001__p12687170546">Specifies the project ID.</p>
</td>
</tr>
<tr id="vpc_ipv6_0001__row4719141983620"><td class="cellrowborder" valign="top" width="24.452445244524455%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_ipv6_0001__p7719171912368">floatingips_links</p>
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_ipv6_0001__p20720819203612">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="57.615761576157624%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_ipv6_0001__p15720419103617">Specifies the request URL.</p>
</td>
</tr>
</tbody>
</table>
</div>
<ul id="vpc_ipv6_0001__ul10420184210546"><li id="vpc_ipv6_0001__li12420194265420">Example response<pre class="screen" id="vpc_ipv6_0001__screen5544982151841">{
"floatingips": [
{
"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"
}
],
"floatingips_links": [
{
"href": "https://vpc.region.otctest.t-systems.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&amp;page_reverse=true&amp;page_reverse=True",
"rel": "previous"
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="vpc_ipv6_0001__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_ipv6_0001__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="vpc_ipv6_0001__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_ipv6_0001__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>