forked from docs/doc-exports
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com> Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
799 lines
112 KiB
HTML
799 lines
112 KiB
HTML
<a name="EN-US_TOPIC_0000001854169133"></a><a name="EN-US_TOPIC_0000001854169133"></a>
|
|
|
|
<h1 class="topictitle1">Creating a VPN Gateway</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1487610174615">This API is used to create a VPN gateway. </p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p19989133162813">For details, see <a href="vpn_api_0008.html#EN-US_TOPIC_0000001807530276">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_section46808346"><h4 class="sectiontitle">URI</h4><div class="p" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p585818172469">POST /v5/{project_id}/vpn-gateways
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table3672032" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row10026740"><th align="left" class="cellrowborder" valign="top" width="20.61793820617938%" id="mcps1.3.3.2.1.2.5.1.1"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p6859639">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.02809719028097%" id="mcps1.3.3.2.1.2.5.1.2"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p179611479215">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.798820117988202%" id="mcps1.3.3.2.1.2.5.1.3"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p18759866">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.555144485551445%" id="mcps1.3.3.2.1.2.5.1.4"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p43154149">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row5825185"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p2077973">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.02809719028097%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p177965479212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.798820117988202%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p34098154">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1995217523354">Specifies a project ID. You can obtain the project ID by referring to <a href="vpn_api_0051.html#EN-US_TOPIC_0000001807530332">Obtaining the Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul5992193374713"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li59922337473">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table65350" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row4415535111211"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p4415153516124">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p441653516129">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1641611350126">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p13417123517128">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row144151935131214"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p154177357126">vpn_gateway</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p7418153518120"><a href="#EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92125">CreateVgwRequestBodyContent</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p18418635111217">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p10419183513124">Specifies the VPN gateway object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92125"></a><a name="en-us_topic_0000001594352981_table92125"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92125" frame="border" border="1" rules="all"><caption><b>Table 3 </b>CreateVgwRequestBodyContent</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row365163314812"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p066163318482">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p20661332485">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p16661033104810">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p156673319483">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row13652033154812"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p12677338484">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p116715338485">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1867193317483">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul4955105118115"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li527124517356">Specifies the name of a VPN gateway.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1627614292618">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li373016333515">If this parameter is not specified, a name in the format of <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b12492172510913">vpngw-</strong><em id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_i41636281096">****</em> is automatically generated, for example, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b220918792618">vpngw-a45b</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row6556125112417"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1355613516416">network_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p95571551246">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p7557051643">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1981816611516"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li6818161855">Specifies the network type of the VPN gateway. A public VPN gateway (<strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1027011116261">public</strong>) uses EIPs to connect to a customer gateway. A private VPN gateway (<strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b20270011142616">private</strong>) uses private IP addresses in a VPC to connect to a customer gateway.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li198181361956">The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b67481113192620">public</strong> or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b197481513102618">private</strong>.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li981819612519">The default value is <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b34131233141210">public</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row665633134815"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p16819334486">attachment_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p5681335483">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p56873313488">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1130314388158"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li6350171513586">Specifies the association mode.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li157311253153513">The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b147287109156">vpc</strong> or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b5746111311515">er</strong>.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li716012567011">The default value is <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1283661710156">vpc</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1651633184814"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p3708339488">er_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p47083314815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p77020336489">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1772325916176"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li78731191813">Specifies the ID of the enterprise router instance to which the VPN gateway connects.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li15909141571315">The value is a UUID containing 36 characters.<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p26764195130"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li15909141571315"></a><a name="en-us_topic_0000001594352981_li15909141571315"></a>This parameter is mandatory when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b77631717102017">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b243132018207">er</strong>, and cannot be configured when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1141515754310">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b113242001445">vpc</strong>.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1665183311481"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1871123319482">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1771193354811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p17110332483">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul561110619364"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li116113611361">Function description:<ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul10190133402318"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li51647326237">When <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b5561163164718">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1656112317474">vpc</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b12561831114712">vpc_id</strong> specifies the ID of the service VPC associated with the VPN gateway.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li124253715234">When <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1342716342479">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1142763415472">er</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b942823434713">vpc_id</strong> specifies the ID of the access VPC used by the VPN gateway. In this case, any VPC ID can be used.</li></ul>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li48031847111316">The value is a UUID containing 36 characters.<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p140471315111"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li48031847111316"></a><a name="en-us_topic_0000001594352981_li48031847111316"></a>This parameter is mandatory when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b187373123554">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1495619134550">vpc</strong>.</p>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1751294941318">When <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b330692719559">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b19854152815550">er</strong>, set either <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1855423217559">vpc_id</strong> or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b175111735185519">access_vpc_id</strong>. Setting <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1513584816559">access_vpc_id</strong> is recommended. If both <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1799185335520">vpc_id</strong> and <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1191815556554">access_vpc_id</strong> are set, only <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b76541117561">access_vpc_id</strong> takes effect.</p>
|
|
</li></ul>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p116691427115711">You can obtain the VPC ID by querying VPCs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row965193334819"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p6722033184817">local_subnets</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p5721933104812">Array of String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p197213330481">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1856318166193"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li15820154514310">Specifies a local subnet. This subnet is a cloud-side subnet that needs to communicate with an on-premises customer subnet through a VPN.<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p3819124520310"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li15820154514310"></a><a name="en-us_topic_0000001594352981_li15820154514310"></a>A maximum of 50 local subnets can be specified for each VPN gateway. For example, a local subnet can be 192.168.52.0/24.</p>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1665632441918">Set this parameter only when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b13676114217475">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b267714426477">vpc</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1565733194810"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1172033204810">connect_subnet</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p127311335482">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1173113313486">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul612412511203"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li212411542011">Specifies the ID of the VPC subnet used by the VPN gateway.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li27641245154816">The value is a UUID containing 36 characters.<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p19364523337"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li27641245154816"></a><a name="en-us_topic_0000001594352981_li27641245154816"></a>This parameter is mandatory when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b7881193615566">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b488211366562">vpc</strong>. If only <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b172111051175610">connect_subnet</strong> is set, or both <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1912721205715">connect_subnet</strong> and <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1274713319579">access_subnet_id</strong> are set and their values are the same, ensure that the subnet has at least four available IP addresses. If both <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b117197510587">connect_subnet</strong> and <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b65031385585">access_subnet_id</strong> are set and their values are different, ensure that each subnet has at least two available IP addresses.</p>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1837115263312">When <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b16293101112158">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1129461141517">er</strong>, set either <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b7294161116154">connect_subnet</strong> or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b8294131117152">access_subnet_id</strong>. Setting <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b12294121110155">access_subnet_id</strong> is recommended. If both <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b9511571507">connect_subnet</strong> and <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b950574013">access_subnet_id</strong> are set, only <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b12585715018">access_subnet_id</strong> takes effect. Ensure that the subnet has at least two available IP addresses.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row11651033104817"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p18734334482">bgp_asn</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p17413334817">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p67413334818">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul3945205718195"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li16945155771916">Specifies the BGP AS number of the VPN gateway.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li37961189164">The value ranges from 1 to 4294967295.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li449692412205">The default value is 64512.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1665143344813"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p12758339482">flavor</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1875113313489">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p167523324814">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul41009515205"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1510012516200">Specifies the specifications of the VPN gateway. For the value range, see the <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1515144716113">Specification</strong> parameter on the page for creating a VPN gateway on the VPN console.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li14529133252211">Value range:<ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul19658423122511"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li18922153842512">V1G</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1168911301260">V300</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li841382432714">Basic</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1351917219258">Professional1</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li477882613257">Professional2</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li372115233513">Professional1-NonFixedIP (not yet supported)</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li965085616510">Professional2-NonFixedIP (not yet supported)</li></ul>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p13145203214254"></p>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1683915346511">This parameter cannot be set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b94031175489">Basic</strong> when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b5403157184819">network_type</strong> is <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b240447194819">private</strong> or when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b14041773488">attachment_type</strong> is <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b124049764819">er</strong>.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li171111538121612">The default value is <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b62791902328">Professional1</strong>.</li></ul>
|
|
<div class="note" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_note7423124615178"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul142519436259"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1055449112519">In earlier versions, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b710612160119">Professional1</strong> is <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b2106151601110">V300</strong>. Using <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b18106616101111">V300</strong> is not recommended.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li642574311250">In earlier versions, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b722682011118">Professional2</strong> is <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1622692041118">V1G</strong>. Using <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1222662041116">V1G</strong> is not recommended.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li542514332510">For the value range, see the <span class="parmname" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_parmname6597151018142"><b>Specification</b></span> parameter on the page for creating a VPN gateway on the VPN console.</li></ul>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1766315682310"></p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row5652339483"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1877133204817">availability_zone_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p777133174820">Array of String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p47713364817">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul24481301260"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1347311298512">Specifies the AZ where the VPN gateway is to be deployed. If this parameter is not specified, an AZ is automatically selected for the VPN gateway. You can obtain the AZ list by referring to <a href="vpn_api_0019.html#EN-US_TOPIC_0000001854089185">Querying the AZs of VPN Gateways</a>.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li73881353164916">If two or more AZs are returned when you <a href="vpn_api_0019.html#EN-US_TOPIC_0000001854089185">query the AZ list of VPN gateways</a>, enter two AZs. If only one AZ is returned, enter this AZ. If no AZ is returned, the VPN gateway cannot be created.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row265183364810"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p67712336483">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p207873319485">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1578103318486">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul2063482642115"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li76340261216">Specifies an enterprise project ID.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li41695419196">The value is a UUID (36 characters) or 0.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li13563307215">The default value is 0, indicating that the resource belongs to the default enterprise project.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row156563344818"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p4791433124820">eip1</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1279153315487"><a href="#EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92126">CreateRequestEip</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p979833174812">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul72054588549"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1520575816546">Specifies the first EIP of the VPN gateway using the active-active mode or the active EIP of the VPN gateway using the active-standby mode.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li59481375582">Set this parameter only when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b78634160481">network_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b186412161489">public</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1265233144814"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p158012339488">eip2</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1480203313486"><a href="#EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92126">CreateRequestEip</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p4808338483">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul13265152835819"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li18265142885811">Specifies the second EIP of the VPN gateway using the active-active mode or the standby EIP of the VPN gateway using the active-standby mode.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li10842163515582">Set this parameter only when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1644315196489">network_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1644391918483">public</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row198171731889"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p3818531682">access_vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p18181831989">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p5818638811">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul2456191054110"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1245671011415">Specifies the ID of the access VPC used by the VPN gateway.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li445612103414">The value is a UUID containing 36 characters.<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p15832114616370"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li445612103414"></a><a name="en-us_topic_0000001594352981_li445612103414"></a>This parameter is optional when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b935542713218">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b106744287218">vpc</strong>. If both <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b183713311926">access_vpc_id</strong> and <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b183855351828">vpc_id</strong> are set, both of them take effect.</p>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p533110315011">When <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b13139118534">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b131392081839">er</strong>, set either <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1214015814317">vpc_id</strong> or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b17141182310">access_vpc_id</strong>. Setting <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b614111814312">access_vpc_id</strong> is recommended. If both <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1034018101636">access_vpc_id</strong> and <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b8340171016319">vpc_id</strong> are set, only <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b134115101138">access_vpc_id</strong> takes effect.</p>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li194564109415">By default, the value is the same as the value of <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b96085273318">vpc_id</strong>.<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p35731218421">You can obtain the VPC ID by querying VPCs.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row172241415181117"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1822418153119">access_subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p142248156110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p7224161521113">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1920143241119"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1620832121111">Specifies the ID of the subnet in the access VPC used by the VPN gateway.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li53771329161610">The value is a UUID containing 36 characters.<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p186243012366"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li53771329161610"></a><a name="en-us_topic_0000001594352981_li53771329161610"></a>This parameter is optional when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1067711468317">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b8732048534">vpc</strong>. If both <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b123035019313">access_subnet_id</strong> and <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b152303500314">connect_subnet</strong> are set and their values are the same, ensure that the subnet has at least four available IP addresses. If both <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b10246185411418">access_subnet_id</strong> and <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b102462549416">connect_subnet</strong> are set and their values are different, ensure that each subnet has at least two available IP addresses.</p>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p20862230103615">When <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1254113056">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b92544310518">er</strong>, set either <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1525403052">access_subnet_id</strong> or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b2254131851">connect_subnet</strong>. Setting <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b12551931520">access_subnet_id</strong> is recommended. If both <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b11511238752">access_subnet_id</strong> and <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b25116381553">connect_subnet</strong> are set, only <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b2511123814514">access_subnet_id</strong> takes effect. Ensure that the subnet has at least two available IP addresses.</p>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li162083291119">By default, the value is the same as the value of <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1116812536219">connect_subnet</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row3236115518431"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p13236155184320">ha_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p202378552435">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p132372556439">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul13646123254417"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li106152124813">Specifies the HA mode of the gateway. The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b121751314101">active-active</strong> or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b350814347104">active-standby</strong>.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1779615212445">Value range: active-active, active-standby</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li11646183212449">Default value: <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b13390191171119">active-active</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row7332145055517"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p123326509553">access_private_ip_1</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p193322506553">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p433255016559">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1783516116017"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li48350114018">Specifies private IP address 1 of a private VPN gateway. Set this parameter if a private VPN gateway needs to use specified IP addresses. In active/standby gateway mode, the specified IP address is the active IP address. In active-active gateway mode, the specified IP address is active IP address 1.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li168351411401">Value range: allocatable IP addresses in the access subnet</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li38351816010">This parameter must be specified together with <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b13405195618545">access_private_ip_2</strong>, and the two parameters must have different values.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row20408615219"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p940816151917">access_private_ip_2</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1089352414116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p085311271918">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul28571139242"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li785713919413">Specifies private IP address 2 of a private VPN gateway. Set this parameter if a private VPN gateway needs to use specified IP addresses. In active/standby gateway mode, the specified IP address is the standby IP address. In active-active gateway mode, the specified IP address is active IP address 2.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1385712392049">Value range: allocatable IP addresses in the access subnet</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li19857153913418">This parameter must be specified together with <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b38820445318">access_private_ip_1</strong>, and the two parameters must have different values.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row141651110219"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p12518647185817">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p155181847125816">Array of <a href="#EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92238">VpnResourceTag</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p951834755816">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul124531254455"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li84543256453">Specifies a tag list.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li145412253459">A maximum of 20 tags can be specified.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92126"></a><a name="en-us_topic_0000001594352981_table92126"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92126" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CreateRequestEip</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row158203313480"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p5832033114810">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.3.2.5.1.2"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1183173384810">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.3.2.5.1.3"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p208373312482">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.3.2.5.1.4"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1283833194815">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row108219335480"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1584633114810">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p684133313483">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p484143320488">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul10375182522312"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1437522592317">Specifies an EIP ID.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1525265511233">The value is a UUID containing 36 characters.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li151995303817">Set this parameter only when an existing EIP is used. The value cannot be the ID of an EIP using shared bandwidth or the ID of a frozen EIP.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row16821633134810"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p8851337484">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p485173354819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1286233124813">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1499072110257"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li11990162182520">Specifies the EIP type.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li02714517482">The value is a string of 0 to 36 characters.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li14319125893">Set this parameter only when a new EIP is used.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1782173310483"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p89116332482">charge_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p491103319488">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p119163313485">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul81892346276"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li12189203412277">Specifies the bandwidth billing mode of an EIP.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li8332185215458">Value range:<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1352841792315"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li8332185215458"></a><a name="en-us_topic_0000001594352981_li8332185215458"></a><strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b18315451302">traffic</strong>: billed by traffic</p>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li12561109144613">Set this parameter only when a new EIP is used.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row98243320484"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p192333144820">bandwidth_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p8931533124813">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p893133344818">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul3179104382717"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1717944317270">Specifies the bandwidth (Mbit/s) of an EIP. The maximum EIP bandwidth varies according to regions and depends on the EIP service. You can submit a service ticket to increase the maximum EIP bandwidth under your account.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li417025410273">The value ranges from 1 to 1000. For details, see the EIP documentation.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li91255457525">Set this parameter only when a new EIP is used.<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p576914545526"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li91255457525"></a><a name="en-us_topic_0000001594352981_li91255457525"></a>The value cannot be greater than 100 when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b3711413162719">flavor</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b19711181316279">Basic</strong>. The value cannot be greater than 300 when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b197111213182718">flavor</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b207111113102719">Professional1</strong>. The value cannot be greater than 1000 when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b177121813162711">flavor</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1712101382716">Professional2</strong>. </p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row2821133134815"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1094173324814">bandwidth_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1294153314818">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p3941433194816">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1923211458282"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li923314517284">Specifies the bandwidth name of an EIP.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li14671181410296">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li104901112112015">Set this parameter only when a new EIP is used.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li116743210554">When a new EIP is used and this parameter is not set, an EIP bandwidth name in the format of <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b135621353105212">vpngw-bandwidth-</strong><em id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_i9104172115312">****</em> is automatically generated, for example, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b14357134744815">vpngw-bandwidth-e1fa</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92238"></a><a name="en-us_topic_0000001594352981_table92238"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92238" frame="border" border="1" rules="all"><caption><b>Table 5 </b>VpnResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row12907152516281"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.4.2.5.1.1"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1790862522818">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.4.2.5.1.2"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1590862511281">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.4.2.5.1.3"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p190822518281">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.4.2.5.1.4"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p11908132532819">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row19907325142817"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p86437477589">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p11643144711589">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p764319470581">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.4.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul65231833153920"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1303152053315">Specifies a tag key.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li152316335391">The value is a string of 1 to 128 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row129071625122816"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p16643847205814">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p764324795815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p18643647195814">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.4.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul961219349376"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li5601175311451">Specifies a tag value.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li186123345379">The value is a string of 0 to 255 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li138914212494">Example requests<ol id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ol01018217464"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li910122124620">Create a VPN gateway that uses existing EIPs and is associated with a VPC.<pre class="screen" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_screen461110416311">POST https://{Endpoint}/v5/{project_id}/vpn-gateways
|
|
|
|
{
|
|
"vpn_gateway": {
|
|
"vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c",
|
|
"local_subnets": [
|
|
"192.168.0.0/24", "192.168.1.0/24"
|
|
],
|
|
"connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"eip1": {
|
|
"id": "cff40e5e-demo-a8df-va86-7366077bf097"
|
|
},
|
|
"eip2": {
|
|
"id": "d290f1ee-demo-a8df-va86-d701748f0851"
|
|
}
|
|
}
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li11601144194616">Create a VPN gateway that uses new EIPs and is associated with an enterprise router.<pre class="screen" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_screen1116711153610">POST https://{Endpoint}/v5/{project_id}/vpn-gateways
|
|
|
|
{
|
|
"vpn_gateway": {
|
|
"name": "vpngw-1234",
|
|
"attachment_type": "er",
|
|
"er_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c",
|
|
"vpc_id": "584a238f-demo-a8df-va86-edca746f6277",
|
|
"connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"bgp_asn": 65533,
|
|
"flavor": "Professional2",
|
|
"availability_zone_ids": [
|
|
<span id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ph19793139112114"> "eu-de-01"</span>
|
|
<span id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ph1579479132117"> "eu-de-02"</span>
|
|
],
|
|
"eip1": {
|
|
"type": "5_bgp",
|
|
<span id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ph134891255282"> </span>
|
|
<span id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ph449482562818"> "charge_mode": "traffic",</span>
|
|
"bandwidth_size": 1000,
|
|
"bandwidth_name": "vpngw-bandwidth-1391"
|
|
},
|
|
"eip2": {
|
|
"type": "5_bgp",
|
|
<span id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ph10186175042816"> "charge_mode": "traffic",</span>
|
|
"bandwidth_size": 1000,
|
|
"bandwidth_name": "vpngw-bandwidth-1392"
|
|
}
|
|
}
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li625310717463">Create a private VPN gateway associated with a VPC.<pre class="screen" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_screen23289426339">POST https://{Endpoint}/v5/{project_id}/vpn-gateways
|
|
|
|
{
|
|
"vpn_gateway": {
|
|
"vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c",
|
|
"local_subnets": [
|
|
"192.168.0.0/24", "192.168.1.0/24"
|
|
],
|
|
"connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"network_type": "private"
|
|
}
|
|
}</pre>
|
|
</li></ol>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul2144514204819"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li61441714114816">Response parameters<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1180563551217"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li61441714114816"></a><a name="en-us_topic_0000001594352981_li61441714114816"></a>Returned status code 201: successful operation</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table65353" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameters in the response body</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1049393521215"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1580514358129">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.009999999999998%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p158064352128">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.769999999999996%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1280673519127">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row3493113512125"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p780673591210">vpn_gateway</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p622713324811"><a href="#EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92129">ResponseVpnGateway</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p780715358123">Specifies the VPN gateway object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row15493235111212"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p19807143518129">request_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p3807153571217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p2807535171212">Specifies a request ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92129"></a><a name="en-us_topic_0000001594352981_table92129"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table92129" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ResponseVpnGateway</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1910563334810"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1222773319486">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.2%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p82281233134812">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.58%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p0228113312480">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row13105113324813"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p7228433174820">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1722833354813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul4510103818305"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li156736439303">Specifies a VPN gateway ID.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li6255157303">The value is a UUID containing 36 characters.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row310511334483"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p322813333488">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p62286336480">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul925111593014"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li7955551161115">Specifies a VPN gateway name. If no VPN gateway name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li152531563019">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), and hyphens (-).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1880091516233"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p8800101572317">network_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p2800191592313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul13252145262311"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li425275211230">Specifies the network type of the VPN gateway.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1325245222313">The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b13852050174819">public</strong> or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b10385105094811">private</strong>.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li225215211231">The default value is <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b198861636046">public</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row14105133344819"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p19229153324817">attachment_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p422953384820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1634315392304"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1434373916306">Specifies the association mode.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1343103917301">The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b449810529414">vpc</strong> or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1249914521349">er</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row71052333482"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1422918332488">er_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p82291733154812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p138542437713">Specifies the ID of the enterprise router instance to which the VPN gateway connects. This parameter is available only when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b13130175212484">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1213035214485">er</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row510573374818"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p12291733104810">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p172301033154819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p15275142916317">When <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b18420195374813">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1642035384813">vpc</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b442075314818">vpc_id</strong> specifies the ID of the service VPC associated with the VPN gateway.</p>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p82752291335">This parameter is not returned when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b162501349595">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b153973665912">er</strong>. To view the ID of the access VPC used by the VPN gateway, check the <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b9670931113">access_vpc_id</strong> field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row11105733134816"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1623043319483">local_subnets</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1923016337483">Array of String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1280230784">Specifies a local subnet. This subnet is a cloud-side subnet that needs to communicate with an on-premises network through a VPN. For example, a local subnet can be 192.168.52.0/24. This parameter is available only when <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b165784574488">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b12578145784814">vpc</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row410533318482"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p122308330483">connect_subnet</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p16230933124810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p03411450102515">Specifies the ID of the VPC subnet used by the VPN gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1010511330483"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p5230143374818">bgp_asn</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1323018339488">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1940410309265">Specifies the BGP AS number of the VPN gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row0106183319489"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p923114331486">flavor</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p52313331485">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul16311126192517"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1131111619251">Specifies the specification of the VPN gateway. For the value range, see the <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b2046786906">Specification</strong> parameter on the page for creating a VPN gateway on the VPN console.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li138324136257">Options:<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p0279132419526"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li138324136257"></a><a name="en-us_topic_0000001594352981_li138324136257"></a><strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b15787197219">v300</strong>: The maximum forwarding bandwidth is 300 Mbit/s. This value has been deprecated, but is retained for compatibility purposes. Using this value is not recommended.</p>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p166101051185212"><strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b19224124618217">v1g</strong>: The maximum forwarding bandwidth is 1 Gbit/s. This value has been deprecated, but is retained for compatibility purposes. Using this value is not recommended.</p>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p16333218288"><strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1253161016592">Basic</strong>: The maximum forwarding bandwidth is 100 Mbit/s.</p>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1824457132913"><strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b81255189597">Professional1</strong>: The maximum forwarding bandwidth is 300 Mbit/s.</p>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1150012864618"><strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b564118524421">Professional1-NonFixedIP</strong> (not yet supported): The maximum forwarding bandwidth is 300 Mbit/s.</p>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p114585512299"><strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b6234103910440">Professional2</strong>: The maximum forwarding bandwidth is 1 Gbit/s.</p>
|
|
<p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p115224362468"><strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b960185716424">Professional2-NonFixedIP</strong> (not yet supported): The maximum forwarding bandwidth is 1 Gbit/s.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row17677102103414"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1367711217340">connection_number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p292181374">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1967742133416">Specifies the maximum number of VPN connections supported for the VPN gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row01062339483"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p6231203334814">used_connection_number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1123112339488">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1256516395315p0">Specifies the number of VPN connections that have been used by the VPN gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row11158935449"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p264512575115">used_connection_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p815919351242">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1355133495311">Specifies the number of VPN connection groups that have been used by the VPN gateway. A connection group consists of two connections between a customer gateway and a VPN gateway. By default, 10 VPN connection groups are included free of charge with the purchase of a VPN gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row710673314484"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p023223364818">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p723218339484">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1346517119494"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1243612127408">Specifies an enterprise project ID.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li144651611124913">The value is a UUID (36 characters) or 0.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row396114192217"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p896144115225">access_vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p189624116227">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul15906343192415"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li8906114317244">Specifies the ID of the access VPC used by the VPN gateway.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li14906114318244">The value is a UUID containing 36 characters.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row155341014255"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p153418072512">access_subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p8534170132513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul7121212102510"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1612131216253">Specifies the ID of the subnet in the access VPC used by the VPN gateway.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li312141282510">The value is a UUID containing 36 characters.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1289352612499"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1273517484494">ha_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p128931826204917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul745813232509"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li245822325012">Specifies the HA mode of the gateway. The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b36671147759">active-active</strong> or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b9667104716514">active-standby</strong>.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li18458102315013">Value range: active-active, active-standby</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1458102365015">Default value: <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b159223514517">active-active</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row595972513124"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p18598928133217">policy_template</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p030394417348"><a href="#EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table204661634173912">PolicyTemplate</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p10380171723620">Specifies a policy template. This parameter is returned only for a VPN gateway that supports access via non-fixed IP addresses.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row9960168416"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p14785225145413">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p147855259548">Array of <a href="#EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table4138248135518">VpnResourceTag</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1280042717591">Specifies a tag list.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table4138248135518"></a><a name="en-us_topic_0000001594352981_table4138248135518"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table4138248135518" frame="border" border="1" rules="all"><caption><b>Table 8 </b>VpnResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row313874885517"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.4.2.4.1.1"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1613864810559">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.009999999999998%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p11138114805517">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.769999999999996%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p913874812558">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row5138148125515"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p464719221116">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1364712219116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1164712221919"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1664713221916">Specifies a tag key.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li16474228116">The value is a string of 1 to 128 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row16139174885513"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p664772216112">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p106479222114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul116471022213"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li7647192212119">Specifies a tag value.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li12647192212113">The value is a string of 0 to 255 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table204661634173912"></a><a name="en-us_topic_0000001594352981_table204661634173912"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table204661634173912" frame="border" border="1" rules="all"><caption><b>Table 9 </b>PolicyTemplate</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row346673433917"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.5.2.4.1.1"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p5466173423918">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.009999999999998%" id="mcps1.3.5.2.1.5.2.4.1.2"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p7466103410397">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.769999999999996%" id="mcps1.3.5.2.1.5.2.4.1.3"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1546613417392">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row746633403918"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p746613412398">ike_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p164664342393"><a href="#EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table6755101415474">IkePolicy</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p143123388232">Specifies the IKE policy object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1646618346399"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p18466183413914">ipsec_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p19533522114210"><a href="#EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table1512731654717">IpsecPolicy</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1499115261518">Specifies the IPsec policy object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table6755101415474"></a><a name="en-us_topic_0000001594352981_table6755101415474"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table6755101415474" frame="border" border="1" rules="all"><caption><b>Table 10 </b>IkePolicy</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row1975511141475"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.6.2.4.1.1"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p67551514134711">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.009999999999998%" id="mcps1.3.5.2.1.6.2.4.1.2"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p17755141484713">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.769999999999996%" id="mcps1.3.5.2.1.6.2.4.1.3"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p11755614164713">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row10755514184716"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p197569141474">encryption_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p375601416472">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.6.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul7481132141015"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li748172120107">Specifies an encryption algorithm.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li20481192111105">The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b155861337151719">aes-256-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b8587163771717">aes-128-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b195871037191715">aes-256</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b11587103781713">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b5587163718178">aes-128</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row17756914114715"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p12756161434713">dh_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p8756111417474">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.6.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1948182111109"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li28627445718">Specifies the DH group used for key exchange in phase 1.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li14481182121010">The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1724734614173">group14</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1324764671711">group15</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b19247104631719">group16</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b7247154611719">group19</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b142472460176">group20</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b62471446101713">group21</strong>, or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b424884681717">disable</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row663551512525"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p86351615195211">authentication_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p363661518529">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.6.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul11212415102"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li2121184131012">Specifies an authentication algorithm.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li5121941171018">The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b047635061716">sha2-512</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1747655015170">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1847735091716">sha2-256</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row6168122910526"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p716962917527">lifetime_seconds</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p191691129135210">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.6.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul1448120211104"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li648116215104">Specifies the SA lifetime. When the lifetime expires, an IKE SA is automatically updated.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li3481162181011">The value ranges from 60 to 604800, in seconds.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table1512731654717"></a><a name="en-us_topic_0000001594352981_table1512731654717"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_table1512731654717" frame="border" border="1" rules="all"><caption><b>Table 11 </b>IpsecPolicy</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row4128171613476"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.7.2.4.1.1"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1212812165479">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.009999999999998%" id="mcps1.3.5.2.1.7.2.4.1.2"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p11281316154714">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.769999999999996%" id="mcps1.3.5.2.1.7.2.4.1.3"><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1812812163473">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row312812169474"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p13128151619472">authentication_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p198856403535">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul148555357565"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1885518359564">Specifies an authentication algorithm.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li138551835155615">The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b51681151101714">sha2-512</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1416845151713">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1816813513172">sha2-256</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row91281616134712"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p412831617474">encryption_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p392819526534">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul312124112109"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1608112013145">Specifies an encryption algorithm.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li168031229145818">The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b15921113831712">aes-256-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1892133814174">aes-128-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1192163819173">aes-256</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b169211238121717">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1292123815178">aes-128</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row31451857135314"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p91451857115316">pfs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1814517579533">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul121216411104"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li312114416109">Specifies the DH key group used by PFS.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li2121194119106">The value can be <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b15907174713177">group14</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b1907174713172">group15</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b190764710175">group16</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b149071947101711">group19</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b139071447181711">group20</strong>, <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b149071647101713">group21</strong>, or <strong id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_b690719476178">disable</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_row465311593535"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p3653135965313">lifetime_seconds</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p1465365915535">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ul15122541141014"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li18122184110108">Specifies the lifetime of a tunnel established over an IPsec connection.</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li412214112104">The value ranges from 30 to 604800, in seconds.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li169592039174916">Example responses<ol id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_ol337612458463"><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li6376345134615">Response to the request for creating a VPN gateway that uses existing EIPs and is associated with a VPC<pre class="screen" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_screen743913556180">{
|
|
"vpn_gateway": {
|
|
"id": "134f9fb1-demo-a8df-va86-2040a5c13325",
|
|
"name": "vpngw-9f24",
|
|
"network_type": "public",
|
|
"attachment_type": "vpc",
|
|
"vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
|
|
"local_subnets": ["192.168.0.0/24"],
|
|
"connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"bgp_asn": 64512,
|
|
"flavor": "Professional1",
|
|
"connection_number": 200,
|
|
"used_connection_number": 0,
|
|
"used_connection_group": 0,
|
|
"enterprise_project_id": "0",
|
|
"access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
|
|
"access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"ha_mode": "active-active"
|
|
},
|
|
"request_id": "7b37532a-d6e4-46b9-98dc-9169ec2ca58f"
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li1061111472463">Response to the request for creating a VPN gateway that uses new EIPs and is associated with an enterprise router<pre class="screen" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_screen742519264203">{
|
|
"vpn_gateway": {
|
|
"id": "80ac167b-demo-a8df-va86-a9a2a23223b8",
|
|
"name": "vpngw-1234",
|
|
"network_type": "public",
|
|
"attachment_type": "er",
|
|
"er_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c",
|
|
"bgp_asn": 65533,
|
|
"flavor": "Professional2",
|
|
"connection_number": 200,
|
|
"used_connection_number": 0,
|
|
"used_connection_group": 0,
|
|
"enterprise_project_id": "0",
|
|
"access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
|
|
"access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"ha_mode": "active-active"
|
|
},
|
|
"request_id": "cd71cade-bfbd-410b-b672-4bfe46cfc311"
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_li4992649194619">Response to the request for creating a private VPN gateway associated with a VPC<pre class="screen" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_screen14326984388">{
|
|
"vpn_gateway": {
|
|
"id": "80ac167b-demo-a8df-va86-a9a2a23223b8",
|
|
"name": "vpngw-1234",
|
|
"network_type": "private",
|
|
"attachment_type": "vpc",
|
|
"vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c",
|
|
"local_subnets": ["192.168.0.0/24", "192.168.1.0/24"],
|
|
"connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"bgp_asn": 65533,
|
|
"flavor": "Professional2",
|
|
"connection_number": 200,
|
|
"used_connection_number": 0,
|
|
"used_connection_group": 0,
|
|
"enterprise_project_id": "0",
|
|
"access_vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c",
|
|
"access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"ha_mode": "active-active"
|
|
},
|
|
"request_id": "cd71cade-bfbd-410b-b672-4bfe46cfc311"
|
|
}</pre>
|
|
</li></ol>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001854169133__en-us_topic_0000001594352981_p18112112662914">For details, see <a href="vpn_api_0052.html#EN-US_TOPIC_0000001807370508">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0013.html">VPN Gateway</a></div>
|
|
</div>
|
|
</div>
|
|
|