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

511 lines
49 KiB
HTML
Raw 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="CreateVirtualGateway"></a><a name="CreateVirtualGateway"></a>
<h1 class="topictitle1">Creating a Virtual Gateway</h1>
<div id="body8662426"><div class="section" id="CreateVirtualGateway__en-us_topic_0000001735666304_section477123022812"><h4 class="sectiontitle">Function</h4><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p67712302284">This API is used to create a virtual gateway.</p>
</div>
<div class="section" id="CreateVirtualGateway__en-us_topic_0000001735666304_section167803062812"><h4 class="sectiontitle">URI</h4><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p6781304283">POST /v3/{project_id}/dcaas/virtual-gateways</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001735666304_table37983019289" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1078330162819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1279103012282">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p879163072817">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1580730182810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p48014301281">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1178123032819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p180163012289">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p148011309286">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p5805305288">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p68117304283">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateVirtualGateway__en-us_topic_0000001735666304_section2081113013287"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001735666304_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row381173072819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p2825307280">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1882730152817">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p13831130202811">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p14838301282">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1082203019286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p483133062812">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1783163011286">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p08423052818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p128423092817">Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the <em id="CreateVirtualGateway__en-us_topic_0000001735666304_i16617101619174">Identity and Access Management API Reference</em>. The token is the value of <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b146171016161711">X-Subject-Token</strong> in the response header.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p9843306282">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b8617151681718">0</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1784163019286">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b206176162171">10240</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001735666304_request_CreateVirtualGatewayRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row188593062810"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p11851930122818">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p886103013284">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p208653014285">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1586153092812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row185183011285"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p138611305286">virtual_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1686173019283">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1687123082810"><a href="#CreateVirtualGateway__en-us_topic_0000001735666304_request_CreateVirtualGateway">CreateVirtualGateway</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1887330192812">Specifies the virtual gateway to be created.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateVirtualGateway__en-us_topic_0000001735666304_request_CreateVirtualGateway"></a><a name="en-us_topic_0000001735666304_request_CreateVirtualGateway"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001735666304_request_CreateVirtualGateway" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CreateVirtualGateway</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1688133062813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1289123018289">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p13904309281">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1990173016287">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p89063002819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row19881030192812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p69043020283">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p199183012814">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1291143092818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p891130172819">Specifies the ID of the VPC that the virtual gateway is associated with. This parameter is mandatory when a virtual gateway is used by a connection for accessing a VPC.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row588143016289"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p991133013283">enterprise_router_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p99163052811">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p13921830112819">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p892103072815">Specifies the ID of the enterprise router that the virtual gateway is attached to. This parameter is mandatory when a virtual gateway is attached to an enterprise router.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1488230152814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p179223019285">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1792143042813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1093203032820">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1893123019286">Specifies the virtual gateway name.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p169363019285">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b1262910167172">0</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p3931430182810">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b6629141621718">64</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row5881130112813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p189393032818">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p993230152815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p79423002818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p09423072819">Provides supplementary information about the virtual gateway.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p159493015288">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b263131617179">0</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1394193014285">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b76312016171718">128</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row188530102817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p14941330192813">local_ep_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p18951307285">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p795193013283">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p395153018282">Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway. This parameter is mandatory when a virtual gateway is used by a connection for accessing a VPC.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1388153092816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p199593010288">local_ep_group_ipv6</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p396103052811">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p159613309281">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p119623042817">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="CreateVirtualGateway__en-us_topic_0000001735666304_row789123032815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p69611303283">bgp_asn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1896230132818">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p129703052810">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p129733016287">Specifies the local BGP autonomous system number (ASN) of the virtual gateway.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p597143072812">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b1635151691713">1</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p119714302283">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b126353169177">4294967295</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1589143042820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p797123092810">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1098203002812">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p149812308286">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p11106143015281">Specifies the ID of the enterprise project that the virtual gateway belongs to.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p310613011282">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b963731619175">36</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p13106230162813">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b56371616191719">36</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row13897306284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p141076301281">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p01071030192813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p10107230122819">Array of <a href="#CreateVirtualGateway__en-us_topic_0000001735666304_request_Tag">Tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p710793017281">Specifies the tags.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p11081930152815">Array length: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b9682538178">010</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateVirtualGateway__en-us_topic_0000001735666304_request_Tag"></a><a name="en-us_topic_0000001735666304_request_Tag"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001735666304_request_Tag" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Tag</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row20108153032816"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p151091930162813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p4109530132813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p910953016286">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1211033072816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1210853013288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1911033017286">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p111108304283">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p2110530142820">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><div class="p" id="CreateVirtualGateway__en-us_topic_0000001735666304_p988813512470">Specifies the tag key. The key:<ul id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_ul161904329534"><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li19190153219534">Cannot be left blank.</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li7190432145319">Must be unique for each resource.</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li181905324537">Can contain a maximum of 36 Unicode characters.</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li1219019324535">Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).</li></ul>
</div>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row010823010285"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p21111430122816">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p31111430142817">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p211253012289">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><div class="p" id="CreateVirtualGateway__en-us_topic_0000001735666304_p422514116535">Specifies the tag value. The value:<ul id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_ul15189353205316"><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li51898538530">Can be left blank.</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li16189195355312">Can contain a maximum of 43 Unicode characters.</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_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="CreateVirtualGateway__en-us_topic_0000001735666304_section91121430192812"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p6113103002815"><strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b16646181661711">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001735666304_response_ShowVirtualGatewayResponseBody" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row18113133013288"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p611493092817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p711423012818">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p111415301283">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1211314307288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p7114430152819">virtual_gateway</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p15115330162815"><a href="#CreateVirtualGateway__en-us_topic_0000001735666304_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="CreateVirtualGateway__en-us_topic_0000001735666304_p8115183092820">Specifies the virtual gateway.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row61131530162814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p9115183016281">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p511593092815">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p181166305285">Specifies the request ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateVirtualGateway__en-us_topic_0000001735666304_response_VirtualGateway"></a><a name="en-us_topic_0000001735666304_response_VirtualGateway"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001735666304_response_VirtualGateway" frame="border" border="1" rules="all"><caption><b>Table 7 </b>VirtualGateway</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row2011753072820"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1511933062813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p112063015289">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p4120133015287">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row16117133015284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p212073016282">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p5120133010283">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p14121183017285">Specifies the virtual gateway ID.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1611793019280"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p812113017286">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1112123018286">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p15122133018284">Specifies the ID of the VPC connected using the virtual gateway.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row511711301283"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1412215307288">enterprise_router_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1122133010282">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p31227305285">Specifies the ID of the enterprise router that the virtual gateway is attached to.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row6117330142810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p712363013282">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p0123143012814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1212311304285">Specifies the project ID.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p11237303281">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b12658016201718">32</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1012363062816">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b265841661717">32</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row9118930122815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p10124183022811">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p13124103020284">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p912411306285">Specifies the virtual gateway name.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p112413301283">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b3659151641713">0</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p141246308287">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b9090669">64</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1111893014288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p0125930142811">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p712573032819">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p212516303288">Provides supplementary information about the virtual gateway.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1212563032818">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b1166119169173">0</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p412593012285">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b10661171661718">128</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row3118630172810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p2126203092810">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p181262030102817">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p111261230102818">Specifies the virtual gateway type. The value can only be <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b1662216101713">default</strong>.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p31261330192817">Default: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b86621516201719">default</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row211814302284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p9126130132816">local_ep_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p101271030122812">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1012713300282">Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1911803062812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p11271730122817">local_ep_group_ipv6</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p8127430142820">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1012853010286">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="CreateVirtualGateway__en-us_topic_0000001735666304_row111181530182817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p7128163032818">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p2128183012811">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p212843010284">Specifies the administrative status. The value can be <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b196658164177">true</strong> or <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b146654162173">false</strong>.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p121284303282">Default: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b9665916171718">true</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1311833015282"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p18129730122816">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p12129130192813">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p312920304284">Specifies the operating status. The value can be <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b858041422116">ACTIVE</strong>, <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b458019141216">DOWN</strong>, <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b15811914182118">BUILD</strong>, <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b95811914162113">ERROR</strong>, <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b65818143219">PENDING_CREATE</strong>, <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b7582141452113">PENDING_UPDATE</strong>, or <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b1058271411211">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row311883018284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p19129113052815">bgp_asn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p712917307285">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p0130113062812">Specifies the local BGP ASN of the virtual gateway.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1213011304280">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b1879455911">1</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p151309309287">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b1642495264">4294967295</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row15118183012810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1013014309288">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p2130730102816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1613153018286">Specifies the ID of the enterprise project that the virtual gateway belongs to.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p41311030172818">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b874788160">36</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p131315306284">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b5669141671717">36</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row3118330162813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p013114307281">device_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p2131930132819">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p11321230162818">Specifies the ID of the device that the virtual interface belongs to.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1811883012814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p913283010288">redundant_device_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1213253022813">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p14132630192814">Specifies the ID of the redundant device.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1111820301283"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p17132173012287">public_border_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p8133193062816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1413343016289">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="CreateVirtualGateway__en-us_topic_0000001735666304_row1311853012286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p613303011283">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p2013393016283">Array of <a href="#CreateVirtualGateway__en-us_topic_0000001735666304_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="CreateVirtualGateway__en-us_topic_0000001735666304_p12134163092820">Specifies the tags.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p14134133052818">Array length: <strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b3861883170">010</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateVirtualGateway__en-us_topic_0000001735666304_response_Tag"></a><a name="en-us_topic_0000001735666304_response_Tag"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001735666304_response_Tag" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Tag</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_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="CreateVirtualGateway__en-us_topic_0000001735666304_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="CreateVirtualGateway__en-us_topic_0000001735666304_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="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_p19138320103413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_row68621619203416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_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="CreateVirtualGateway__en-us_topic_0000001735666304_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="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_p988813512470">Specifies the tag key. The key:<ul id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_ul161904329534_1"><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li19190153219534_1">Cannot be left blank.</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li7190432145319_1">Must be unique for each resource.</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li181905324537_1">Can contain a maximum of 36 Unicode characters.</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li1219019324535_1">Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).</li></ul>
</div>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_row78621819123417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_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="CreateVirtualGateway__en-us_topic_0000001735666304_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="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_p422514116535">Specifies the tag value. The value:<ul id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_ul15189353205316_1"><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li51898538530_1">Can be left blank.</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li16189195355312_1">Can contain a maximum of 43 Unicode characters.</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_en-us_topic_0000001735825404_li181891853115318_1">Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).</li></ul>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateVirtualGateway__en-us_topic_0000001735666304_section66913307287"><h4 class="sectiontitle">Example Requests</h4><ul id="CreateVirtualGateway__en-us_topic_0000001735666304_ul1869163072816"><li id="CreateVirtualGateway__en-us_topic_0000001735666304_li196911530152819">Creating a virtual gateway that will be used to access a VPC, with the local BGP ASN set to 64512 and the IPv4 subnet to 192.168.1.0/24<pre class="screen" id="CreateVirtualGateway__en-us_topic_0000001735666304_screen1691173013284">POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways
{
"virtual_gateway" : {
"name" : "vgw-c7b22",
"description" : "",
"vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
"bgp_asn" : 64512,
"local_ep_group" : [ "192.168.1.0/24" ]
}
}</pre>
</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_li11691143011286">Creating a virtual gateway that will be attached to an enterprise router and set the BGP ASN to 64512<pre class="screen" id="CreateVirtualGateway__en-us_topic_0000001735666304_screen06911030152811">POST https://{dc_endpoint}/v3/92ea72fe26294aa180a2712c28e43c21/dcaas/virtual-gateways
{
"virtual_gateway" : {
"name" : "vgw-er",
"description" : "",
"type" : "default",
"enterprise_router_id" : "61fa53c9-4446-4ebd-89b9-11a52b653a9c",
"bgp_asn" : 64512
}
}
</pre>
</li></ul>
</div>
<div class="section" id="CreateVirtualGateway__en-us_topic_0000001735666304_section1769119302282"><h4 class="sectiontitle">Example Responses</h4><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1692193020280"><strong id="CreateVirtualGateway__en-us_topic_0000001735666304_b16783191614176">Status code: 201</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001735666304_p14692123013285">Created</p>
<ul id="CreateVirtualGateway__en-us_topic_0000001735666304_ul6692143002810"><li id="CreateVirtualGateway__en-us_topic_0000001735666304_li156923309288">The virtual gateway for accessing the VPC is created<pre class="screen" id="CreateVirtualGateway__en-us_topic_0000001735666304_screen146921230152819">{
"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"
}
}</pre>
</li><li id="CreateVirtualGateway__en-us_topic_0000001735666304_li469233020289">The virtual gateway that will be attached to an enterprise router is created<pre class="screen" id="CreateVirtualGateway__en-us_topic_0000001735666304_screen1069283002812">{
"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
}
}</pre>
</li></ul>
</div>
<div class="section" id="CreateVirtualGateway__en-us_topic_0000001735666304_section14701163017284"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001735666304_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row1217983052818"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p107021330132816">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p770283018282">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001735666304_row6179133062815"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p1070223032818">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p87021230152814">Created</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateVirtualGateway__en-us_topic_0000001735666304_section167022301285"><h4 class="sectiontitle">Error Codes</h4><p id="CreateVirtualGateway__en-us_topic_0000001735666304_p14702430132811">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>