vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dc/api-ref/ShowVirtualGateway.html
Qin Ying, Fan 62ab8a5fe2 DC API 20231101 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-03-11 15:10:40 +00:00

325 lines
29 KiB
HTML
Raw Permalink Blame History

<a name="ShowVirtualGateway"></a><a name="ShowVirtualGateway"></a>
<h1 class="topictitle1">Querying Details About a Virtual Gateway</h1>
<div id="body8662426"><div class="section" id="ShowVirtualGateway__en-us_topic_0000001782745845_section583517111711"><h4 class="sectiontitle">Function</h4><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p138353716175">This API is used to query details about a specified virtual gateway.</p>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001782745845_section1836177141712"><h4 class="sectiontitle">URI</h4><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p283697141715">GET /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowVirtualGateway__en-us_topic_0000001782745845_table583837171716" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row1083711701718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1983815716173">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1983917781716">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p198391574173">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p384027191717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row583710711173"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p384097111717">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p12840157131718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p118417713179">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p0841187111720">Specifies the project ID.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row18373781711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p0842187161715">virtual_gateway_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p684213781715">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p208430791718">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p48434715178">Specifies the virtual gateway ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowVirtualGateway__en-us_topic_0000001782745845_table1884410751717" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row108444711713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p15845107171713">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1584557171716">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p10845197131720">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p38469721710">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row1884437121712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p8846375179">fields</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p08477719175">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p138471872177">Array</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p484719741716">Specifies the list of fields to be displayed.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p128480719172">Array Length: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b1984867191713">1 - 5</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001782745845_section28482781719"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowVirtualGateway__en-us_topic_0000001782745845_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row98498751719"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p168501373179">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p198501072176">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p13851277178">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p185118714172">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row158495781715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1385227101715">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p17852157141710">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p118527721712">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p685315771717">Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the <em id="ShowVirtualGateway__en-us_topic_0000001782745845_i19853147101712">Identity and Access Management API Reference</em>. The token is the value of <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b8853197101714">X-Subject-Token</strong> in the response header.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p158533731716">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b18534718178">0</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p285415751716">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b6854197181713">10240</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001782745845_section12854137191719"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p7854107131715"><strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b785527201713">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowVirtualGateway__en-us_topic_0000001782745845_response_ShowVirtualGatewayResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row1485511731713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1856117201711">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p108562741714">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p8857374179">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row1785577111714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1885717161720">virtual_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p17858117181718"><a href="#ShowVirtualGateway__en-us_topic_0000001782745845_response_VirtualGateway">VirtualGateway</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p38584714172">Specifies parameters for creating a virtual gateway.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row198556791719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1085918719179">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p5859157101715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p12859177121720">Specifies the request ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowVirtualGateway__en-us_topic_0000001782745845_response_VirtualGateway"></a><a name="en-us_topic_0000001782745845_response_VirtualGateway"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowVirtualGateway__en-us_topic_0000001782745845_response_VirtualGateway" frame="border" border="1" rules="all"><caption><b>Table 5 </b>VirtualGateway</caption><thead align="left"><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row1986112771719"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p18631715178">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p13863127101717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1386412711179">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row58614720173"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1886427171716">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p28652714172">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p28658761717">Specifies the virtual gateway ID.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row128618718174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1286510741716">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p186613741712">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p19866127111711">Specifies the ID of the VPC connected by the virtual gateway.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row686119719174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p148671077176">enterprise_router_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p118678716174">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p198671715177">Specifies the ID of the enterprise router that the virtual gateway is attached to.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row486117791712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p28687741715">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p178681278174">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1786913781711">Specifies the ID of the project that the instance belongs to.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p38692711171">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b128693718173">32</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p98691778173">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b187019781719">32</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row1586117111719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1387015721716">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p128704720178">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p13871127131720">Specifies the virtual gateway name.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p487137191718">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b1187111761714">0</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1187177191713">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b168710741718">64</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row128612741711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p19872479172">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p8872973170">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p78731279172">Provides supplementary information about the virtual gateway.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p28731079171">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b1873117181715">0</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1687317710171">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b187337151711">128</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row9861377174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p178741478171">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p887419741714">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1987417711175">Specifies the virtual gateway type. The value can only be <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b58751574171">default</strong>.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1687518712171">Default: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b13875976178">default</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row68611721712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p987512771713">local_ep_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p138767716170">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p13876177181718">Specifies the IPv4 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row1486118721713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p18771471172">local_ep_group_ipv6</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p187710701718">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p118781976174">Specifies the IPv6 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. This is a reserved field.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row38625714178"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1687815771710">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p138798715176">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p148794761718">Specifies the administrative status, which can be <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b1987911761716">true</strong> or <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b1879147161713">false</strong>.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p787911791717">Default: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b1888011719172">true</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row88629751711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p188097191713">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p9880677175">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1588117131712">Specifies the virtual gateway status, which can be <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b9881476176">ACTIVE</strong>, <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b688113731718">DOWN</strong>, <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b388110712170">BUILD</strong>, <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b78811577176">ERROR</strong>, <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b58811673177">PENDING_CREATE</strong>, <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b1888110721719">PENDING_UPDATE</strong>, or <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b288147101715">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row2862137121715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p19882370172">bgp_asn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1988215711179">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p118831679171">Specifies the local BGP ASN of the virtual gateway.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1788317791714">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b1883207101710">1</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p6883197151712">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b1588311731712">4294967295</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row286297151718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p0884777173">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1884177161711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1288516719173">Specifies the ID of the enterprise project that the virtual gateway belongs to.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p68851771171">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b58851772174">36</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p188854715172">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b2885107191712">36</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row1986215717179"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p198861578172">device_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p8886147121716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p198879711177">Specifies the ID of the device that the virtual interface belongs to.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row186287101719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1588716719174">redundant_device_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p4887197191718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p14888775171">Specifies the ID of the redundant device.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row68621673177"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p28886711174">public_border_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p2889127121718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p10889778178">Specifies the public border group of the AZ, indicating whether the site is a HomeZones site.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001782745845_section98981716171"><h4 class="sectiontitle">Example Requests</h4><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p38991975177">Querying a virtual gateway</p>
<pre class="screen" id="ShowVirtualGateway__en-us_topic_0000001782745845_screen4899197191717">GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0</pre>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001782745845_section1189911751719"><h4 class="sectiontitle">Example Responses</h4><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p19900187191720"><strong id="ShowVirtualGateway__en-us_topic_0000001782745845_b1090067101714">Status code: 200</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001782745845_p1690015716176">OK</p>
<ul id="ShowVirtualGateway__en-us_topic_0000001782745845_ul1290016791716"><li id="ShowVirtualGateway__en-us_topic_0000001782745845_li1990057161713">The details of the virtual gateway associated with a VPC are queried.<pre class="screen" id="ShowVirtualGateway__en-us_topic_0000001782745845_screen390218713174">{
"virtual_gateway" : {
"id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
"name" : "vgw-c7b22",
"description" : "",
"tenant_id" : "0605768a3300d5762f82c01180692873",
"vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
"device_id" : "26.151.63.100",
"redundant_device_id" : "26.152.128.20",
"type" : "default",
"status" : "ACTIVE",
"admin_state_up" : true,
"bgp_asn" : 64512,
"local_ep_group" : [ "192.168.1.0/24" ],
"enterprise_project_id" : "0",
"public_border_group" : "center"
},
"request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
}</pre>
</li><li id="ShowVirtualGateway__en-us_topic_0000001782745845_li169063719179">The details of the virtual gateway attached to an enterprise router are queried.<pre class="screen" id="ShowVirtualGateway__en-us_topic_0000001782745845_screen179070741714">{
"virtual_gateway" : {
"name" : "vgw-er",
"id" : "7a91797a-cbda-42ff-9f42-73f26c993dd9",
"description" : "",
"tenant_id" : "92ea72fe26294aa180a2712c28e43c21",
"vpc_id" : null,
"enterprise_router_id" : "61fa53c9-4446-4ebd-89b9-11a52b653a9c",
"device_id" : "26.151.63.100",
"redundant_device_id" : "26.152.128.20",
"type" : "default",
"status" : "ACTIVE",
"admin_state_up" : true,
"bgp_asn" : 64512,
"local_ep_group" : null,
"local_ep_group_ipv6" : null,
"public_border_group" : null
},
"request_id" : "765f7aaf8f2edd0e719de564e8765fg4"
}</pre>
</li></ul>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001782745845_section743118131717"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowVirtualGateway__en-us_topic_0000001782745845_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row149360791718"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p2439817173">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p443288178">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001782745845_row5936376176"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p0434851714">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p64320861710">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001782745845_section0433861715"><h4 class="sectiontitle">Error Codes</h4><p id="ShowVirtualGateway__en-us_topic_0000001782745845_p154419810179">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Virtual Gateway</a></div>
</div>
</div>
View Git Blame Copy Permalink