yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
as_openapi
doc-exports/docs/dc/api-ref/ShowVirtualGateway.html
fanqinying 070036121f DC API 20241129 version 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: fanqinying <fanqinying@huawei.com>
Co-committed-by: fanqinying <fanqinying@huawei.com>
2025-09-08 13:31:33 +00:00

363 lines
34 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<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_0000001735666300_section96489174142"><h4 class="sectiontitle">Function</h4><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p8648417141410">This API is used to query details about a specific virtual gateway.</p>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001735666300_section664931710142"><h4 class="sectiontitle">URI</h4><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p564912171144">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_0000001735666300_table176501617181412" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row18650161741417"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p136511017121413">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_0000001735666300_p8651117151414">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_0000001735666300_p4651017141413">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_0000001735666300_p6652161719141">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row7650161711145"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p1665217177145">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_0000001735666300_p965291721414">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_0000001735666300_p1653817101416">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_0000001735666300_p5653917191410">Specifies the project ID.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row126504173144"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p17654917161418">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_0000001735666300_p7654101718144">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_0000001735666300_p10655191751416">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_0000001735666300_p196551017171413">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_0000001735666300_table1165641771413" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row10656101721413"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p12656717101414">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_0000001735666300_p1765714174146">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_0000001735666300_p206571317161419">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_0000001735666300_p2657131712146">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row865671710148"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p5658161710145">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_0000001735666300_p126581717121412">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_0000001735666300_p7659161713147">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_0000001735666300_p76591817141414">Specifies the list of fields to be displayed.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p765931781417">Array length: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b1984867191713">1–5</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001735666300_section565917171144"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowVirtualGateway__en-us_topic_0000001735666300_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_0000001735666300_row466071713147"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p11661191731412">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_0000001735666300_p1066111716146">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_0000001735666300_p1662141717144">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_0000001735666300_p19662917101416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row146601217151414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p7662181717140">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_0000001735666300_p566313179148">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_0000001735666300_p18663101720148">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_0000001735666300_p166641917121418">Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the <em id="ShowVirtualGateway__en-us_topic_0000001735666300_i19853147101712">Identity and Access Management API Reference</em>. The token is the value of <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b8853197101714">X-Subject-Token</strong> in the response header.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p6664141718147">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b18534718178">0</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p15664171761416">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b6854197181713">10240</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001735666300_section196651817121413"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p3665171771412"><strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b785527201713">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowVirtualGateway__en-us_topic_0000001735666300_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_0000001735666300_row156661917171412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p8667151751417">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_0000001735666300_p2668217171419">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_0000001735666300_p5668111717149">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row126671317171418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p186681617201418">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_0000001735666300_p156692017111417"><a href="#ShowVirtualGateway__en-us_topic_0000001735666300_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_0000001735666300_p9669161719143">Specifies the virtual gateway.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row14667151711410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p167031719141">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_0000001735666300_p467031715143">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_0000001735666300_p10671181712141">Specifies the request ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowVirtualGateway__en-us_topic_0000001735666300_response_VirtualGateway"></a><a name="en-us_topic_0000001735666300_response_VirtualGateway"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowVirtualGateway__en-us_topic_0000001735666300_response_VirtualGateway" frame="border" border="1" rules="all"><caption><b>Table 5 </b>VirtualGateway</caption><thead align="left"><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row9672131714148"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p567571711148">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_0000001735666300_p8675121721411">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_0000001735666300_p12675117161417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row667241711418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p176761517201411">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_0000001735666300_p367661701415">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_0000001735666300_p116771217191410">Specifies the virtual gateway ID.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row1167251719141"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p6677101711146">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_0000001735666300_p567720179147">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_0000001735666300_p6678517191411">Specifies the ID of the VPC connected using the virtual gateway.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row46729172148"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p11678181731418">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_0000001735666300_p46784171140">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_0000001735666300_p17679151731419">Specifies the ID of the enterprise router that the virtual gateway is attached to.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row1067301712141"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p967917177142">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_0000001735666300_p0679151741413">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_0000001735666300_p968051719149">Specifies the project ID.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p368017176142">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b128693718173">32</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p186808177147">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b187019781719">32</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row1667311176147"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p36813172147">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_0000001735666300_p9681111761418">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_0000001735666300_p9681017131419">Specifies the virtual gateway name.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p176819172141">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b1187111761714">0</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p1068211718148">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b168710741718">64</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row6673131716141"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p26821217141415">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_0000001735666300_p1682417191419">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_0000001735666300_p10683171721415">Provides supplementary information about the virtual gateway.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p196831017161417">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b1873117181715">0</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p4683171731415">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b187337151711">128</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row46731317151418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p7684617131410">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_0000001735666300_p4684617171413">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_0000001735666300_p368491710144">Specifies the virtual gateway type. The value can only be <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b58751574171">default</strong>.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p136854178146">Default: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b13875976178">default</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row146731317121417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p176853179146">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_0000001735666300_p668581718146">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_0000001735666300_p968681751412">Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row1767341717145"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p768614179142">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_0000001735666300_p14687517181419">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_0000001735666300_p1468751719145">Specifies the IPv6 subnets of the associated VPC that can be accessed over the virtual gateway. This is a reserved field.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row186731817171416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p668721751416">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_0000001735666300_p10688201771417">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_0000001735666300_p1868841761420">Specifies the administrative status. The value can be <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b1987911761716">true</strong> or <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b1879147161713">false</strong>.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p5688161741420">Default: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b1888011719172">true</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row3673217161412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p76895178148">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_0000001735666300_p06891617121419">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_0000001735666300_p15689017141411">Specifies the operating status. The value can be <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b48911159142015">ACTIVE</strong>, <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b4892125992010">DOWN</strong>, <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b1889345942016">BUILD</strong>, <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b289315992014">ERROR</strong>, <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b128942592201">PENDING_CREATE</strong>, <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b138941859152010">PENDING_UPDATE</strong>, or <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b9895759162014">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row156731017151412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p1569011710148">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_0000001735666300_p1669017171147">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_0000001735666300_p186901217101412">Specifies the local BGP ASN of the virtual gateway.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p4691181717144">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b1883207101710">1</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p66916177144">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b1588311731712">4294967295</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row166731317191413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p869141715146">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_0000001735666300_p106921817181419">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_0000001735666300_p8692131721419">Specifies the ID of the enterprise project that the virtual gateway belongs to.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p106928171149">Minimum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b58851772174">36</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p1969301751415">Maximum: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b2885107191712">36</strong></p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row66731217191417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p4693817171417">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_0000001735666300_p76934177144">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_0000001735666300_p106946177146">Specifies the ID of the device that the virtual interface belongs to.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row116730177148"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p6694181712142">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_0000001735666300_p1469451781410">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_0000001735666300_p16695111791414">Specifies the ID of the redundant device.</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row967321721415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p3695111751417">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_0000001735666300_p14696141712144">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_0000001735666300_p12696141716142">Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)</p>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row10674101781414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p069711741418">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p1069714173142">Array of <a href="#ShowVirtualGateway__en-us_topic_0000001735666300_response_Tag">Tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p106981917151410">Specifies the tags.</p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p669871791416">Array length: <strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b188915719176">0–10</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowVirtualGateway__en-us_topic_0000001735666300_response_Tag"></a><a name="en-us_topic_0000001735666300_response_Tag"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowVirtualGateway__en-us_topic_0000001735666300_response_Tag" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Tag</caption><thead align="left"><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_row386111195349"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_p71389204345">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_p113892053413">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_p19138320103413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_row68621619203416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_p1313811204343">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_p6138132013342">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><div class="p" id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_p988813512470">Specifies the tag key. The key:<ul id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_ul161904329534"><li id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_li19190153219534">Cannot be left blank.</li><li id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_li7190432145319">Must be unique for each resource.</li><li id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_li181905324537">Can contain a maximum of 36 Unicode characters.</li><li id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_li1219019324535">Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).</li></ul>
</div>
</td>
</tr>
<tr id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_row78621819123417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_p2138122003420">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_p8138182073414">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><div class="p" id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_p422514116535">Specifies the tag value. The value:<ul id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_ul15189353205316"><li id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_li51898538530">Can be left blank.</li><li id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_li16189195355312">Can contain a maximum of 43 Unicode characters.</li><li id="ShowVirtualGateway__en-us_topic_0000001735666300_en-us_topic_0000001735825404_li181891853115318">Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).</li></ul>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001735666300_section19704151714144"><h4 class="sectiontitle">Example Requests</h4><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p57041717191411">Querying a virtual gateway</p>
<pre class="screen" id="ShowVirtualGateway__en-us_topic_0000001735666300_screen1370418179142">GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0</pre>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001735666300_section3705817101415"><h4 class="sectiontitle">Example Responses</h4><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p1970516173147"><strong id="ShowVirtualGateway__en-us_topic_0000001735666300_b1090067101714">Status code: 200</strong></p>
<p id="ShowVirtualGateway__en-us_topic_0000001735666300_p9705131716146">OK</p>
<ul id="ShowVirtualGateway__en-us_topic_0000001735666300_ul37066173144"><li id="ShowVirtualGateway__en-us_topic_0000001735666300_li1170610178148">The details of the virtual gateway associated with a VPC are queried.<pre class="screen" id="ShowVirtualGateway__en-us_topic_0000001735666300_screen137076170146">{
"virtual_gateway" : {
"id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
"name" : "vgw-c7b22",
"description" : "",
"tenant_id" : "0605768a3300d5762f82c01180692873",
"vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
"tags": [],
"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_0000001735666300_li9710141731419">The details of the virtual gateway attached to an enterprise router are queried.<pre class="screen" id="ShowVirtualGateway__en-us_topic_0000001735666300_screen19711191731413">{
"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",
"tags": [],
"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_0000001735666300_section08491317171410"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowVirtualGateway__en-us_topic_0000001735666300_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row11735617171415"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p484931713147">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_0000001735666300_p7849111714149">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowVirtualGateway__en-us_topic_0000001735666300_row20735101719146"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p184920175141">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_0000001735666300_p88499170145">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowVirtualGateway__en-us_topic_0000001735666300_section7849181711413"><h4 class="sectiontitle">Error Codes</h4><p id="ShowVirtualGateway__en-us_topic_0000001735666300_p1385041721410">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 Gateways</a></div>
</div>
</div>
View Git Blame Copy Permalink