forked from docs/doc-exports
Qin Ying, Fan
62ab8a5fe2
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>
109 lines
7.7 KiB
HTML
109 lines
7.7 KiB
HTML
<a name="en-us_topic_0055025330"></a><a name="en-us_topic_0055025330"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Virtual Interface List</h1>
|
|
<div id="body1495543735580"><div class="section" id="en-us_topic_0055025330__section17487184"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0055025330__p51221589">This API is used to query the virtual interface list.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025330__section23166934"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0055025330__p3694165418338">GET /v2.0/dcaas/virtual-interfaces</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025330__section64582388"><a name="en-us_topic_0055025330__section64582388"></a><a name="section64582388"></a><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0055025330__p145634143416"><a href="#en-us_topic_0055025330__table2198437322244">Table 1</a> lists the request parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025330__table2198437322244"></a><a name="table2198437322244"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025330__table2198437322244" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="en-us_topic_0055025330__row4304807922244"><th align="left" class="cellrowborder" valign="top" width="17.511751175117514%" id="mcps1.3.3.3.2.5.1.1"><p id="en-us_topic_0055025330__p6505580022244">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.221522152215222%" id="mcps1.3.3.3.2.5.1.2"><p id="en-us_topic_0055025330__p329696222244">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.64176417641764%" id="mcps1.3.3.3.2.5.1.3"><p id="en-us_topic_0055025330__p3257067222244">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.62496249624962%" id="mcps1.3.3.3.2.5.1.4"><p id="en-us_topic_0055025330__p5470821922244">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025330__row5451891922244"><td class="cellrowborder" valign="top" width="17.511751175117514%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-us_topic_0055025330__p6157819622316">fields</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.221522152215222%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-us_topic_0055025330__p757920222316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.64176417641764%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-us_topic_0055025330__p4706384922316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.62496249624962%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-us_topic_0055025330__p28609808152757">Specifies the parameters expected to be returned.</p>
|
|
<p id="en-us_topic_0055025330__p970883222316">If you do not specify it, all parameters will be returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025330__section44370581"><a name="en-us_topic_0055025330__section44370581"></a><a name="section44370581"></a><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0055025330__p2714668115724"><a href="#en-us_topic_0055025330__table10476506155243">Table 2</a> lists the response parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025330__table10476506155243"></a><a name="table10476506155243"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025330__table10476506155243" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="en-us_topic_0055025330__row28606500155243"><th align="left" class="cellrowborder" valign="top" width="23.762376237623762%" id="mcps1.3.4.3.2.4.1.1"><p id="en-us_topic_0055025330__p28732152155335">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.742574257425744%" id="mcps1.3.4.3.2.4.1.2"><p id="en-us_topic_0055025330__p45602971155335">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.495049504950494%" id="mcps1.3.4.3.2.4.1.3"><p id="en-us_topic_0055025330__p29780927155335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025330__row17724599155243"><td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025330__p26406454155243">virtual_interfaces</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025330__p58548062155243">List</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.495049504950494%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025330__p2699206155243">Specifies the virtual interface list.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="en-us_topic_0055025330__p410163811553">For details about the <strong id="en-us_topic_0055025330__b187041528811">virtual_interfaces</strong> field, see <a href="en-us_topic_0055025328.html#en-us_topic_0055025328__en-us_topic_0070658680_table1529059104553">Table 1</a>.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025330__section63790914"><a name="en-us_topic_0055025330__section63790914"></a><a name="section63790914"></a><h4 class="sectiontitle">Examples</h4><ul id="en-us_topic_0055025330__ul6664017311189"><li id="en-us_topic_0055025330__li8136179163615">Example request<ol id="en-us_topic_0055025330__ol177688259362"><li id="en-us_topic_0055025330__li7768725143615">Querying all virtual interfaces</li></ol>
|
|
<pre class="screen" id="en-us_topic_0055025330__screen19768925103617">GET /v2.0/dcaas/virtual-interfaces</pre>
|
|
<ol start="2" id="en-us_topic_0055025330__ol1059633819363"><li id="en-us_topic_0055025330__li1859673863620">Querying a virtual interface by ID</li></ol>
|
|
<pre class="screen" id="en-us_topic_0055025330__screen259623823612">GET /v2.0/dcaas/virtual-interfaces?id=67c59cf4-1a64-46c7-763f-22eb1b9e8986</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en-us_topic_0055025330__ul8137653183619"><li id="en-us_topic_0055025330__li13137185393619">Example response<pre class="screen" id="en-us_topic_0055025330__screen565106378">{
|
|
"virtual_interfaces" : [{
|
|
"id": "026895e2-23bf-44bd-8ef1-93618ab92b99",
|
|
"name": "vif-test",
|
|
"description": null,
|
|
"tenant_id": "06057679cc80d5762fb2c01e71b5a593",
|
|
"direct_connect_id": "b07d42dc-6137-4af3-a93b-853d879ae268",
|
|
"vgw_id": "d27d5bd2-97b3-4bd8-b7e5-189a71c14846",
|
|
"type": "private",
|
|
"service_type": "vpc",
|
|
"vlan": 2202,
|
|
"bandwidth": 6,
|
|
"local_gateway_v4_ip": "16.16.16.1/30",
|
|
"remote_gateway_v4_ip": "16.16.16.2/30",
|
|
"route_mode": "static",
|
|
"bgp_asn": null,
|
|
"bgp_md5": null,
|
|
"remote_ep_group_id": "31dd8536-1ac7-4a38-b2fc-178a69f11b11",
|
|
"service_ep_group_id": null,
|
|
"status": "ACTIVE",
|
|
"create_time": "2021-12-15T06:55:46Z",
|
|
"admin_state_up": true,
|
|
"rate_limit": false,
|
|
"enable_bfd": false,
|
|
"health_check_source_ip": null,
|
|
"route_limit": 50,
|
|
"address_family": "ipv4",
|
|
"local_gateway_v6_ip": null,
|
|
"remote_gateway_v6_ip": null,
|
|
"region_id": null,
|
|
"enable_nqa": false,
|
|
"enable_gre": false,
|
|
"local_gre_tunnel_ip": null,
|
|
"remote_gre_tunnel_ip": null,
|
|
"lag_id": null
|
|
}]
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en-us_topic_0055025330__section44742592173353"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0055025330__p176816317298">For details, see <a href="en-us_topic_0055025342.html">Common Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0055025327.html">Virtual Interface</a></div>
|
|
</div>
|
|
</div>
|
|
|