doc-exports/docs/dc/api-ref/en-dc_topic_0055025332.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

276 lines
22 KiB
HTML

<a name="en-dc_topic_0055025332"></a><a name="en-dc_topic_0055025332"></a>
<h1 class="topictitle1">Querying a Virtual Interface</h1>
<div id="body1495543735580"><div class="section" id="en-dc_topic_0055025332__section62587221143243"><h4 class="sectiontitle">Function</h4><p id="en-dc_topic_0055025332__p37587768143243">This API is used to query a virtual interface.</p>
</div>
<div class="section" id="en-dc_topic_0055025332__section13727974143243"><h4 class="sectiontitle">URI</h4><p id="en-dc_topic_0055025332__p734430887">GET /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025332__table1222245015813" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-dc_topic_0055025332__row12230205015819"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.3.2.5.1.1"><p id="en-dc_topic_0055025332__p162305501281">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.42785721427857%" id="mcps1.3.2.3.2.5.1.2"><p id="en-dc_topic_0055025332__p9230650285">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.2.3.2.5.1.3"><p id="en-dc_topic_0055025332__p19230450783">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.85571442855714%" id="mcps1.3.2.3.2.5.1.4"><p id="en-dc_topic_0055025332__p152371550289">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025332__row023735012814"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-dc_topic_0055025332__p2023716501788">virtual_interface_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en-dc_topic_0055025332__p123716501816">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-dc_topic_0055025332__p4244175012817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="42.85571442855714%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-dc_topic_0055025332__p1624475015815">Specifies the virtual interface ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025332__section48686650143243"><h4 class="sectiontitle">Request</h4><p id="en-dc_topic_0055025332__p192851925494"><a href="#en-dc_topic_0055025332__table7546806143243">Table 2</a> lists the request parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025332__table7546806143243"></a><a name="table7546806143243"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025332__table7546806143243" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="en-dc_topic_0055025332__row9156029143243"><th align="left" class="cellrowborder" valign="top" width="25.4%" id="mcps1.3.3.3.2.5.1.1"><p id="en-dc_topic_0055025332__p18912799143243">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.09%" id="mcps1.3.3.3.2.5.1.2"><p id="en-dc_topic_0055025332__p46366729143243">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.080000000000002%" id="mcps1.3.3.3.2.5.1.3"><p id="en-dc_topic_0055025332__p7326913143243">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.43%" id="mcps1.3.3.3.2.5.1.4"><p id="en-dc_topic_0055025332__p5940989143243">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025332__row18016354143243"><td class="cellrowborder" valign="top" width="25.4%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-dc_topic_0055025332__p43004679143243">virtual_interface_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.09%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-dc_topic_0055025332__p44279538143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.080000000000002%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-dc_topic_0055025332__p8623001143243">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46.43%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-dc_topic_0055025332__p13272417143243">Specifies the virtual interface ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025332__section60387869143243"><h4 class="sectiontitle">Response</h4><p id="en-dc_topic_0055025332__p2714668115724"><a href="#en-dc_topic_0055025332__table10476506155243">Table 3</a> lists the response parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025332__table10476506155243"></a><a name="table10476506155243"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025332__table10476506155243" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter</caption><thead align="left"><tr id="en-dc_topic_0055025332__row28606500155243"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.3.2.4.1.1"><p id="en-dc_topic_0055025332__p28732152155335">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.3.2.4.1.2"><p id="en-dc_topic_0055025332__p45602971155335">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47%" id="mcps1.3.4.3.2.4.1.3"><p id="en-dc_topic_0055025332__p29780927155335">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025332__row17724599155243"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-dc_topic_0055025332__p26406454155243">virtual_interface</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-dc_topic_0055025332__p58548062155243">Dictionary data structure</p>
</td>
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-dc_topic_0055025332__p2699206155243">Specifies the <strong id="en-dc_topic_0055025332__b842352706193939">virtual_interface</strong> object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025332__table13084897143243" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of field <strong id="en-dc_topic_0055025332__b1377011152118">virtual_interface</strong></caption><thead align="left"><tr id="en-dc_topic_0055025332__row63914967143243"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.4.2.4.1.1"><p id="en-dc_topic_0055025332__p41919048143243">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.4.4.2.4.1.2"><p id="en-dc_topic_0055025332__p60468452143243">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48%" id="mcps1.3.4.4.2.4.1.3"><p id="en-dc_topic_0055025332__p55013545143243">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025332__row53726974143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p12584516143546">id</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p49386488143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p45354670143546">Specifies the virtual interface ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row4176548143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p44986957143546">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p31860680143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p23896857143546">Specifies the project ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row65710368143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p52697866143546">name</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p10086124143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p20902416143546">Specifies the virtual interface name.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row19355927143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p48892798143546">description</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p22343196143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p20562460143546">Provides supplementary information about the virtual interface.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row34730217143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p7641284143546">direct_connect_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p38562298143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p35796647143546">Specifies the connection ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row36563176143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p8926816143546">vgw_ id</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p24519566143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p28461994143546">Specifies the virtual gateway ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row36603909143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p43021704143546">type</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p11645223143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p40836314143546">Specifies the virtual interface type. The value can be <strong id="en-dc_topic_0055025332__b842352706142157">public</strong> or <strong id="en-dc_topic_0055025332__b84235270614220">private</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row44061354143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p22611601143546">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p20247790143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p31831409143546">Specifies the access service type. The value can be <strong id="en-dc_topic_0055025332__b1650500527142036">vpc</strong>, <strong id="en-dc_topic_0055025332__b26378606142036">public service</strong>, or <strong id="en-dc_topic_0055025332__b1032837367142036">vpc and public service</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row53174924143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p57907931143546">vlan</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p15690831212825">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p3896574143546">Specifies the VLAN used by the local gateway to communicate with the remote gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row44429599143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p2367582143546">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p5717726819440">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p39737423143546">Specifies the virtual interface bandwidth.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row14409097143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p12644148143546">local_gateway_v4_ip</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p35923497143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p3939547143546">Specifies the IPv4 address of the local gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row49533369143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p25908295143546">remote_gateway_v4_ip</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p52274971143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p48820178143546">Specifies the IPv4 address of the remote gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row7065973143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p25025401143546">route_mode</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p9245370143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p52631845143546">Specifies the routing mode. The value can be <strong id="en-dc_topic_0055025332__b84235270614653">static</strong> or <strong id="en-dc_topic_0055025332__b84235270614655">bgp</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row62791961143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p7702136143546">bgp_asn</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p27569269143546">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p44565943143546">Specifies the AS number of the BGP peer.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row58065084143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p45788287143546">bgp_md5</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p43941858143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p38906626143546">Specifies the MD5 password of the BGP peer.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row54977426143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p5096015143546">remote_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p51775955143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p55585133143546">Specifies the ID of the remote endpoint group that records the tenant CIDR blocks.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row32539190143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p19542158143546">service_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p45749592143546">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p33407370143546">Specifies the ID of the service endpoint group that records the public service CIDR blocks.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row2152096161637"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p26810415161640">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p12233240161640">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p56556788161640">Specifies the time when the virtual interface is created.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row32718554171555"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p5120253317162">delete_time</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p5376451317162">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p2478359417162">Specifies the time when the virtual interface is deleted.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row3274315019446"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p5495181219448">status</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p2191175019448">String</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p54377194155258">Specifies the virtual interface status.</p>
<p id="en-dc_topic_0055025332__p1580958519448">The value can be <strong id="en-dc_topic_0055025332__b84235270617169">ACTIVE</strong>, <strong id="en-dc_topic_0055025332__b842352706171613">DOWN</strong>, <strong id="en-dc_topic_0055025332__b842352706171618">BUILD</strong>, <strong id="en-dc_topic_0055025332__b842352706171622">ERROR</strong>, <strong id="en-dc_topic_0055025332__b842352706171626">PENDING_CREATE</strong>, <strong id="en-dc_topic_0055025332__b842352706171630">PENDING_UPDATE</strong>, <strong id="en-dc_topic_0055025332__b842352706171633">PENDING_DELETE</strong>, <strong id="en-dc_topic_0055025332__b1047171556233155">DELETED</strong>, <strong id="en-dc_topic_0055025332__b1391270644233155">AUTHORIZATION</strong>, or <strong id="en-dc_topic_0055025332__b741943905233155">REJECTED</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row18618790143546"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p54352348143546">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p4968436143546">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p5500751815534">Specifies the administrative status of the virtual interface.</p>
<p id="en-dc_topic_0055025332__p49075090143546">The value can be <strong id="en-dc_topic_0055025332__b842352706154840">true</strong> or <strong id="en-dc_topic_0055025332__b842352706154844">false</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025332__row1917945155117"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025332__p12835141012514">rate_limit</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025332__p98351610105120">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025332__p18835191019516">Specifies whether to limit the traffic rate. The value can be <strong id="en-dc_topic_0055025332__b2038123114512">true</strong> or <strong id="en-dc_topic_0055025332__b439183118514">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025332__section23585659143243"><h4 class="sectiontitle">Examples</h4><ul id="en-dc_topic_0055025332__ul173950181018"><li id="en-dc_topic_0055025332__li133125011011">Example request<pre class="screen" id="en-dc_topic_0055025332__screen46559038143243">GET /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}</pre>
</li></ul>
</div>
<ul id="en-dc_topic_0055025332__ul6693718115"><li id="en-dc_topic_0055025332__li116936113112">Example response<pre class="screen" id="en-dc_topic_0055025332__screen0361413191115">{
"virtual_interface" : {
"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_0055025332__section14947747173413"><h4 class="sectiontitle">Returned Value</h4><p id="en-dc_topic_0055025332__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>