doc-exports/docs/dc/api-ref/en-dc_topic_0055025330.html
Qin Ying, Fan 4a7d4f4cd8 DC API 0930 version
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2022-10-06 09:33:01 +00:00

257 lines
22 KiB
HTML

<a name="en-dc_topic_0055025330"></a><a name="en-dc_topic_0055025330"></a>
<h1 class="topictitle1">Querying the Virtual Interface List</h1>
<div id="body1495543735580"><div class="section" id="en-dc_topic_0055025330__section17487184"><h4 class="sectiontitle">Function</h4><p id="en-dc_topic_0055025330__p51221589">This API is used to query the virtual interface list.</p>
</div>
<div class="section" id="en-dc_topic_0055025330__section23166934"><h4 class="sectiontitle">URI</h4><p id="en-dc_topic_0055025330__p3694165418338">GET /v2.0/dcaas/virtual-interfaces</p>
</div>
<div class="section" id="en-dc_topic_0055025330__section64582388"><h4 class="sectiontitle">Request</h4><p id="en-dc_topic_0055025330__p145634143416"><a href="#en-dc_topic_0055025330__table2198437322244">Table 1</a> lists the request parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025330__table2198437322244"></a><a name="table2198437322244"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025330__table2198437322244" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="en-dc_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-dc_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-dc_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-dc_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-dc_topic_0055025330__p5470821922244">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025330__row5451891922244"><td class="cellrowborder" valign="top" width="17.511751175117514%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-dc_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-dc_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-dc_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-dc_topic_0055025330__p28609808152757">Specifies the parameters expected to be returned.</p>
<p id="en-dc_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-dc_topic_0055025330__section44370581"><h4 class="sectiontitle">Response</h4><p id="en-dc_topic_0055025330__p2714668115724"><a href="#en-dc_topic_0055025330__table10476506155243">Table 2</a> lists the response parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025330__table10476506155243"></a><a name="table10476506155243"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025330__table10476506155243" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="en-dc_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-dc_topic_0055025330__p28732152155335">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.693069306930692%" id="mcps1.3.4.3.2.4.1.2"><p id="en-dc_topic_0055025330__p45602971155335">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.54455445544555%" id="mcps1.3.4.3.2.4.1.3"><p id="en-dc_topic_0055025330__p29780927155335">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025330__row17724599155243"><td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-dc_topic_0055025330__p26406454155243">virtual_interfaces</p>
</td>
<td class="cellrowborder" valign="top" width="30.693069306930692%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-dc_topic_0055025330__p58548062155243">List data structure</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-dc_topic_0055025330__p2699206155243">Specifies the virtual interface list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025330__table14681450" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of field <strong id="en-dc_topic_0055025330__b8423527069345">virtual_interfaces</strong></caption><thead align="left"><tr id="en-dc_topic_0055025330__row21069217"><th align="left" class="cellrowborder" valign="top" width="33.663366336633665%" id="mcps1.3.4.4.2.4.1.1"><p id="en-dc_topic_0055025330__p28885026">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.792079207920793%" id="mcps1.3.4.4.2.4.1.2"><p id="en-dc_topic_0055025330__p57985771">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.54455445544555%" id="mcps1.3.4.4.2.4.1.3"><p id="en-dc_topic_0055025330__p4499576">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025330__row28785503142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p54569191142315">id</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p41421726142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p17104065142315">Specifies the virtual interface ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row21517991142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p4563876142315">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p47935545142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p7252844142315">Specifies the project ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row39252187142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p27399442142315">name</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p51949177142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p27300093142315">Specifies the virtual interface name.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row9820119142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p62556265142315">description</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p42012219142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p51707266142315">Provides supplementary information about the virtual interface.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row24079154142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p44220931142315">direct_connect_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p24161680142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p8116402142315">Specifies the connection ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row2026400142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p343562142315">vgw_ id</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p24624790142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p1221885142315">Specifies the virtual gateway ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row22414652142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p10673824142315">type</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p5440057142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p44068500142315">Specifies the virtual interface type. The value can be <strong id="en-dc_topic_0055025330__b842352706142157">public</strong> or <strong id="en-dc_topic_0055025330__b84235270614220">private</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row13919876142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p14759603142315">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p24751912142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p45173146142315">Specifies the access service type. The value can be <strong id="en-dc_topic_0055025330__b1650500527142036">vpc</strong>, <strong id="en-dc_topic_0055025330__b26378606142036">public service</strong>, or <strong id="en-dc_topic_0055025330__b1032837367142036">vpc and public service</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row30135492142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p12348862142315">vlan</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p15690831212825">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p32938441142315">Specifies the VLAN used by the local gateway to communicate with the remote gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row52865460142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p4471746142315">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p5039092419428">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p57231560142315">Specifies the virtual interface bandwidth.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row1174788142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p61891493142315">local_gateway_v4_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p38024775142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p47464297142315">Specifies the IPv4 address of the local gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row26869652142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p17829191142315">remote_gateway_v4_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p66652503142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p35789093142315">Specifies the IPv4 address of the remote gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row34897189142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p58744713142315">route_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p41137545142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p42045432142315">Specifies the routing mode. The value can be <strong id="en-dc_topic_0055025330__b84235270614653">static</strong> or <strong id="en-dc_topic_0055025330__b84235270614655">bgp</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row49988660142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p10808702142315">bgp_asn</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p10133025142315">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p10631678142315">Specifies the AS number of the BGP peer.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row59271874142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p28139793142315">bgp_md5</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p7655701142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p35180781142315">Specifies the MD5 password of the BGP peer.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row35617238142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p58325078142315">remote_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p63792250142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p27037394142315">Specifies the ID of the remote endpoint group that records the tenant CIDR blocks.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row55969893142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p14866898142315">service_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p40698992142315">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p16622126142315">Specifies the ID of the service endpoint group that records the public service CIDR blocks.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row27199761161621"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p30626851161624">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p17559799161624">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p11516750161624">Specifies the time when the virtual interface is created.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row60433793171435"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p1811107171457">delete_time</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p12482015171457">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p21686962171457">Specifies the time when the virtual interface is deleted.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row3640871019435"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p3412662319438">status</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p1279309419438">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p12169474152744">Specifies the virtual interface status.</p>
<p id="en-dc_topic_0055025330__p4941528219438">The value can be <strong id="en-dc_topic_0055025330__b84235270617169">ACTIVE</strong>, <strong id="en-dc_topic_0055025330__b842352706171613">DOWN</strong>, <strong id="en-dc_topic_0055025330__b842352706171618">BUILD</strong>, <strong id="en-dc_topic_0055025330__b842352706171622">ERROR</strong>, <strong id="en-dc_topic_0055025330__b842352706171626">PENDING_CREATE</strong>, <strong id="en-dc_topic_0055025330__b842352706171630">PENDING_UPDATE</strong>, <strong id="en-dc_topic_0055025330__b842352706171633">PENDING_DELETE</strong>, <strong id="en-dc_topic_0055025330__b100464761233116">DELETED</strong>, <strong id="en-dc_topic_0055025330__b1139764118233116">AUTHORIZATION</strong>, or <strong id="en-dc_topic_0055025330__b1189284423233116">REJECTED</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row50456942142315"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p44246765142315">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p9366191142315">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p10509913152738">Specifies the administrative status of the virtual interface.</p>
<p id="en-dc_topic_0055025330__p32769743142315">The value can be <strong id="en-dc_topic_0055025330__b842352706154840">true</strong> or <strong id="en-dc_topic_0055025330__b842352706154844">false</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025330__row1050793415013"><td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025330__p042015412503">rate_limit</p>
</td>
<td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025330__p542016416507">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025330__p5420194155012">Specifies whether to limit the traffic rate. The value can be <strong id="en-dc_topic_0055025330__b19931171675112">true</strong> or <strong id="en-dc_topic_0055025330__b15931141611519">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025330__section63790914"><h4 class="sectiontitle">Examples</h4><ul id="en-dc_topic_0055025330__ul6664017311189"><li id="en-dc_topic_0055025330__li8136179163615">Example request<ol id="en-dc_topic_0055025330__ol177688259362"><li id="en-dc_topic_0055025330__li7768725143615">All parameters are returned:</li></ol>
<pre class="screen" id="en-dc_topic_0055025330__screen19768925103617">GET /v2.0/dcaas/virtual-interfaces</pre>
<ol start="2" id="en-dc_topic_0055025330__ol1059633819363"><li id="en-dc_topic_0055025330__li1859673863620">Filtered parameters are returned (for example, the filter is ID):</li></ol>
<pre class="screen" id="en-dc_topic_0055025330__screen259623823612">GET /v2.0/dcaas/virtual-interfaces?id=67c59cf4-1a64-46c7-763f-22eb1b9e8986</pre>
</li></ul>
</div>
<ul id="en-dc_topic_0055025330__ul8137653183619"><li id="en-dc_topic_0055025330__li13137185393619">Example response<pre class="screen" id="en-dc_topic_0055025330__screen565106378">{
"virtual_interfaces" : [{
"id" : "67c59cf4-1a64-46c7-763f-22eb1b9e8986",
"tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
"name" : "virtual interface1",
"description" : "",
"direct_connect_id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
"vgw_id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",
"type" : "private",
"service_type" : "vpc",
"vlan" : 100,
"bandwidth" : 10,
"local_gateway_v4_ip" : "180.1.1.1/24",
"remote_gateway_v4_ip" : "180.1.1.2/24",
"route_mode" : "static",
"remote_ep_group_id" : "78e34cf1-5468-87c7-223d-56e78b9699ef"
}]
}</pre>
</li></ul>
<div class="section" id="en-dc_topic_0055025330__section44742592173353"><h4 class="sectiontitle">Returned Value</h4><p id="en-dc_topic_0055025330__p176816317298">For details, see section <a href="en-dc_topic_0055025342.html">Common Returned Values</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-dc_topic_0055025327.html">Virtual Interface</a></div>
</div>
</div>