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>
128 lines
8.5 KiB
HTML
128 lines
8.5 KiB
HTML
<a name="en-us_topic_0055025332"></a><a name="en-us_topic_0055025332"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Virtual Interface</h1>
|
|
<div id="body1495543735580"><div class="section" id="en-us_topic_0055025332__section62587221143243"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0055025332__p37587768143243">This API is used to query a virtual interface.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025332__section13727974143243"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0055025332__p734430887">GET /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025332__table1222245015813" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0055025332__row12230205015819"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.3.2.5.1.1"><p id="en-us_topic_0055025332__p162305501281">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.5.1.2"><p id="en-us_topic_0055025332__p9230650285">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.5.1.3"><p id="en-us_topic_0055025332__p19230450783">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47%" id="mcps1.3.2.3.2.5.1.4"><p id="en-us_topic_0055025332__p152371550289">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025332__row023735012814"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-us_topic_0055025332__p2023716501788">virtual_interface_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en-us_topic_0055025332__p123716501816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-us_topic_0055025332__p4244175012817">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-us_topic_0055025332__p1624475015815">Specifies the virtual interface ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025332__section48686650143243"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0055025332__p192851925494"><a href="#en-us_topic_0055025332__table7546806143243">Table 2</a> lists the request parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025332__table7546806143243"></a><a name="table7546806143243"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025332__table7546806143243" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="en-us_topic_0055025332__row9156029143243"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.3.2.5.1.1"><p id="en-us_topic_0055025332__p18912799143243">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.3.2.5.1.2"><p id="en-us_topic_0055025332__p46366729143243">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.3.2.5.1.3"><p id="en-us_topic_0055025332__p7326913143243">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.3.3.2.5.1.4"><p id="en-us_topic_0055025332__p5940989143243">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025332__row18016354143243"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-us_topic_0055025332__p43004679143243">virtual_interface_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-us_topic_0055025332__p44279538143243">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-us_topic_0055025332__p8623001143243">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-us_topic_0055025332__p13272417143243">Specifies the virtual interface ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025332__section60387869143243"><a name="en-us_topic_0055025332__section60387869143243"></a><a name="section60387869143243"></a><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0055025332__p2714668115724"><a href="#en-us_topic_0055025332__table10476506155243">Table 3</a> lists the response parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025332__table10476506155243"></a><a name="table10476506155243"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025332__table10476506155243" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter</caption><thead align="left"><tr id="en-us_topic_0055025332__row28606500155243"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.3.2.4.1.1"><p id="en-us_topic_0055025332__p28732152155335">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.3.2.4.1.2"><p id="en-us_topic_0055025332__p45602971155335">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.4.3.2.4.1.3"><p id="en-us_topic_0055025332__p29780927155335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025332__row17724599155243"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025332__p26406454155243">virtual_interface</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025332__p58548062155243">Dictionary</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025332__p2699206155243">Specifies the <strong id="en-us_topic_0055025332__b842352706193939">virtual_interface</strong> object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="en-us_topic_0055025332__p09213531562">For details about the <strong id="en-us_topic_0055025332__b1947518815911">virtual_interface</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_0055025332__section23585659143243"><a name="en-us_topic_0055025332__section23585659143243"></a><a name="section23585659143243"></a><h4 class="sectiontitle">Examples</h4><ul id="en-us_topic_0055025332__ul173950181018"><li id="en-us_topic_0055025332__li133125011011">Example request<pre class="screen" id="en-us_topic_0055025332__screen46559038143243">GET /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en-us_topic_0055025332__ul6693718115"><li id="en-us_topic_0055025332__li116936113112">Example response<pre class="screen" id="en-us_topic_0055025332__screen0361413191115">{
|
|
"virtual_interface" : {
|
|
"id": "634c61d0-fd7b-4961-adb6-37a2e3c42d08",
|
|
"name": "test-vif",
|
|
"description": null,
|
|
"tenant_id": "06057682ed80d5762f25c00b5deb794a",
|
|
"direct_connect_id": "73707953-df69-4d03-8df5-b46a087c1424",
|
|
"vgw_id": "9b5cab66-7634-4213-8d01-fa37cb908e12",
|
|
"type": "private",
|
|
"service_type": "vpc",
|
|
"vlan": 687,
|
|
"bandwidth": 2,
|
|
"local_gateway_v4_ip": "11.11.11.1/30",
|
|
"remote_gateway_v4_ip": "11.11.11.2/30",
|
|
"route_mode": "static",
|
|
"bgp_asn": null,
|
|
"bgp_md5": null,
|
|
"remote_ep_group_id": "a2b81f07-826f-40b0-9e8d-17d1af5230cf",
|
|
"service_ep_group_id": null,
|
|
"status": "ACTIVE",
|
|
"create_time": "2021-12-15T08:31:27Z",
|
|
"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_0055025332__section14947747173413"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0055025332__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>
|
|
|