lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dc/api-ref/CreateVirtualGateway.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

428 lines
39 KiB
HTML
Raw Blame History

<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_0000001782745849_section136081816131711"><h4 class="sectiontitle">Function</h4><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p560819169172">This API is used to create a virtual gateway.</p>
</div>
<div class="section" id="CreateVirtualGateway__en-us_topic_0000001782745849_section4609171613170"><h4 class="sectiontitle">URI</h4><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p7609416201719">POST /v3/{project_id}/dcaas/virtual-gateways</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001782745849_table76101016181713" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row1261091619176"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p156104165173">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_0000001782745849_p1861117166178">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_0000001782745849_p13611191613177">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_0000001782745849_p14611216161712">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row6610816131715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p661241619177">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_0000001782745849_p561201614175">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_0000001782745849_p461241618174">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_0000001782745849_p86132163178">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateVirtualGateway__en-us_topic_0000001782745849_section361341651715"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001782745849_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_0000001782745849_row16613516101712"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p16614101691710">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_0000001782745849_p2061514166177">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_0000001782745849_p1661511166176">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_0000001782745849_p86159163171">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row1861441691716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p66152016151713">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_0000001782745849_p2061691620174">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_0000001782745849_p15616161611716">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_0000001782745849_p56174163170">Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the <em id="CreateVirtualGateway__en-us_topic_0000001782745849_i16617101619174">Identity and Access Management API Reference</em>. The token is the value of <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b146171016161711">X-Subject-Token</strong> in the response header.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1261731614171">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b8617151681718">0</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1761721613174">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b206176162171">10240</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001782745849_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_0000001782745849_row166181816171713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p461814161173">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_0000001782745849_p10619816111714">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_0000001782745849_p1261921610176">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_0000001782745849_p961961621716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row66181516201718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p562021601713">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_0000001782745849_p13620816191713">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_0000001782745849_p162131612173"><a href="#CreateVirtualGateway__en-us_topic_0000001782745849_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_0000001782745849_p12621716191718">Specifies parameters for creating a virtual gateway.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateVirtualGateway__en-us_topic_0000001782745849_request_CreateVirtualGateway"></a><a name="en-us_topic_0000001782745849_request_CreateVirtualGateway"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001782745849_request_CreateVirtualGateway" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CreateVirtualGateway</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row6622101661710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1624171613174">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_0000001782745849_p12624216151715">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_0000001782745849_p1062441619172">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_0000001782745849_p15625716121718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row1162221613173"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p10625141618174">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_0000001782745849_p13625121621712">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_0000001782745849_p362617161178">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_0000001782745849_p166261716151713">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_0000001782745849_row7622111661711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p6626316101713">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_0000001782745849_p1962791631713">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_0000001782745849_p1462761615170">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_0000001782745849_p4627101621714">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_0000001782745849_row6622716151716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p3628141621712">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_0000001782745849_p562815166172">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_0000001782745849_p19628201651715">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_0000001782745849_p196298169171">Specifies the virtual gateway name.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p8629151661715">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b1262910167172">0</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p14629121681711">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b6629141621718">64</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row17622141610173"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p06296169178">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_0000001782745849_p1763061671710">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_0000001782745849_p13630316111715">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_0000001782745849_p126302166177">Provides supplementary information about the virtual gateway.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p56314167175">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b263131617179">0</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p463151611712">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b76312016171718">128</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row462321617173"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1363161611175">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_0000001782745849_p196312016171714">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_0000001782745849_p363221610175">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_0000001782745849_p76321516161714">Lists the IPv4 subnets that can be accessed over the virtual gateway. Generally, the list contains the subnet CIDR blocks of the associated VPC. 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_0000001782745849_row11623181661716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p763211616172">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_0000001782745849_p1463331641719">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_0000001782745849_p18633131613176">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_0000001782745849_p5633141611170">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="CreateVirtualGateway__en-us_topic_0000001782745849_row11623816191717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p16634116191710">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_0000001782745849_p1863414168172">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_0000001782745849_p176341516111712">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_0000001782745849_p116357161177">Specifies the local BGP autonomous system number (ASN) of the virtual gateway.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1263518167171">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b1635151691713">1</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p363501621711">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b126353169177">4294967295</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row15623516131714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p16351316111717">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_0000001782745849_p11636191613172">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_0000001782745849_p13636101616170">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_0000001782745849_p1063671616175">Specifies the ID of the enterprise project that the virtual gateway belongs to.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1363681616174">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b963731619175">36</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p26371164175">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b56371616191719">36</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateVirtualGateway__en-us_topic_0000001782745849_section13645171617178"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p10645101681719"><strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b16646181661711">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001782745849_response_ShowVirtualGatewayResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row064611616175"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p156471016111713">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_0000001782745849_p1364811691712">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_0000001782745849_p16648171616178">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row7646171610174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p13648201691712">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_0000001782745849_p1764921618171"><a href="#CreateVirtualGateway__en-us_topic_0000001782745849_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_0000001782745849_p156491316131717">Specifies parameters for creating a virtual gateway.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row14646916141713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p664941615174">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_0000001782745849_p136501216161713">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_0000001782745849_p5650916191718">Specifies the request ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateVirtualGateway__en-us_topic_0000001782745849_response_VirtualGateway"></a><a name="en-us_topic_0000001782745849_response_VirtualGateway"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001782745849_response_VirtualGateway" frame="border" border="1" rules="all"><caption><b>Table 6 </b>VirtualGateway</caption><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row865191631711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p165301611716">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_0000001782745849_p166542161177">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_0000001782745849_p186541616161719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row1465111661719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1665461601711">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_0000001782745849_p1654131619176">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_0000001782745849_p36551016161720">Specifies the virtual gateway ID.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row065113165175"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1065511616175">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_0000001782745849_p76553162175">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_0000001782745849_p1665620167178">Specifies the ID of the VPC connected by the virtual gateway.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row10651616101710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1265616168175">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_0000001782745849_p13656181671718">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_0000001782745849_p665721661714">Specifies the ID of the enterprise router that the virtual gateway is attached to.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row2651516171718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1565731612179">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_0000001782745849_p36576167174">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_0000001782745849_p12658516101716">Specifies the ID of the project that the instance belongs to.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p46581316131713">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b12658016201718">32</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p5658121615175">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b265841661717">32</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row4652916191716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p146585165174">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_0000001782745849_p1665961617170">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_0000001782745849_p965951601711">Specifies the virtual gateway name.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p8659201651714">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b3659151641713">0</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p19659116141711">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b16601165171">64</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row1365211161174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p7660016191712">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_0000001782745849_p12660111615177">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_0000001782745849_p1066015163174">Provides supplementary information about the virtual gateway.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p13661201661720">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b1166119169173">0</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p146612162174">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b10661171661718">128</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row165281621719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p4661121611711">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_0000001782745849_p1466191661713">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_0000001782745849_p266214165171">Specifies the virtual gateway type. The value can only be <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b1662216101713">default</strong>.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p126621716171718">Default: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b86621516201719">default</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row15652121671718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p76621316151715">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_0000001782745849_p15663161619172">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_0000001782745849_p6663131631710">Specifies the IPv4 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row1265261618174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p12663216111710">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_0000001782745849_p1866461621719">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_0000001782745849_p13664716171712">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="CreateVirtualGateway__en-us_topic_0000001782745849_row765271612172"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p866431651716">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_0000001782745849_p1366451616173">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_0000001782745849_p666551620175">Specifies the administrative status, which can be <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b196658164177">true</strong> or <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b146654162173">false</strong>.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p176651163173">Default: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b9665916171718">true</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row15652216201717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1066514161177">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_0000001782745849_p966611619179">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_0000001782745849_p76661016131712">Specifies the virtual gateway status, which can be <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b966671616176">ACTIVE</strong>, <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b266631618178">DOWN</strong>, <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b1466611651717">BUILD</strong>, <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b9666151613172">ERROR</strong>, <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b1766615165178">PENDING_CREATE</strong>, <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b5666171641716">PENDING_UPDATE</strong>, or <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b116666167177">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row0652416161718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p4667141610178">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_0000001782745849_p176671416101715">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_0000001782745849_p1066751618176">Specifies the local BGP ASN of the virtual gateway.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p76671162173">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b566814168174">1</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p14668111616173">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b1066881618173">4294967295</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row15652121641711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p8668716171716">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_0000001782745849_p2668916201710">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_0000001782745849_p11669191661714">Specifies the ID of the enterprise project that the virtual gateway belongs to.</p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p17669181617172">Minimum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b36691816201711">36</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1466971631714">Maximum: <strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b5669141671717">36</strong></p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row19652616131715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p766921661716">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_0000001782745849_p1267051619172">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_0000001782745849_p467041691713">Specifies the ID of the device that the virtual interface belongs to.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row565281691719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1967051671718">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_0000001782745849_p567110168178">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_0000001782745849_p067181681716">Specifies the ID of the redundant device.</p>
</td>
</tr>
<tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row1365281610174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p12671716161717">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_0000001782745849_p1267291617178">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_0000001782745849_p1367231613175">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="CreateVirtualGateway__en-us_topic_0000001782745849_section578261613172"><h4 class="sectiontitle">Example Requests</h4><ul id="CreateVirtualGateway__en-us_topic_0000001782745849_ul478261619178"><li id="CreateVirtualGateway__en-us_topic_0000001782745849_li177824165172">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_0000001782745849_screen878291611713">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_0000001782745849_li197831716171717">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_0000001782745849_screen15783151613178">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_0000001782745849_section1678311631710"><h4 class="sectiontitle">Example Responses</h4><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p18783816131712"><strong id="CreateVirtualGateway__en-us_topic_0000001782745849_b16783191614176">Status code: 201</strong></p>
<p id="CreateVirtualGateway__en-us_topic_0000001782745849_p137831616161718">Created</p>
<ul id="CreateVirtualGateway__en-us_topic_0000001782745849_ul1978361615174"><li id="CreateVirtualGateway__en-us_topic_0000001782745849_li1278361611179">The virtual gateway for accessing the VPC is created<pre class="screen" id="CreateVirtualGateway__en-us_topic_0000001782745849_screen16784916131719">{
"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"
}
}</pre>
</li><li id="CreateVirtualGateway__en-us_topic_0000001782745849_li1478412169179">The virtual gateway that will be attached to an enterprise router is created<pre class="screen" id="CreateVirtualGateway__en-us_topic_0000001782745849_screen1785616181711">{
"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
}
}</pre>
</li></ul>
</div>
<div class="section" id="CreateVirtualGateway__en-us_topic_0000001782745849_section8798151621714"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateVirtualGateway__en-us_topic_0000001782745849_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row1172831611176"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p87981816161713">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_0000001782745849_p17798416201714">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateVirtualGateway__en-us_topic_0000001782745849_row177281516201710"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p1279817163173">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_0000001782745849_p7798131611717">Created</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateVirtualGateway__en-us_topic_0000001782745849_section1879861641713"><h4 class="sectiontitle">Error Codes</h4><p id="CreateVirtualGateway__en-us_topic_0000001782745849_p17981216111718">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