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>
778 lines
86 KiB
HTML
778 lines
86 KiB
HTML
<a name="EN-US_TOPIC_0000001807530284"></a><a name="EN-US_TOPIC_0000001807530284"></a>
|
|
|
|
<h1 class="topictitle1">Querying the VPN Gateway List</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p13670194461617">This API is used to query the VPN gateway list.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_section46808346"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p16514174784711">GET /v5/{project_id}/vpn-gateways</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table3672032" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row10026740"><th align="left" class="cellrowborder" valign="top" width="20.61793820617938%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p6859639">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.02809719028097%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p179611479215">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.798820117988202%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p18759866">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.555144485551445%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p43154149">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row5825185"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p2077973">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.02809719028097%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p177965479212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.798820117988202%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p34098154">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p199639252285">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 class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table92783" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter in a query request</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row584993141512"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p138492313158">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1584918318159">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1185017371513">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p98501361516">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row151641552155"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p655610534113">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p15562532119">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1555618531015">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p165561753817">Specifies an enterprise project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul5992193374713"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li59922337473">Request parameters<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1069410455515"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li59922337473"></a><a name="en-us_topic_0000001543513480_li59922337473"></a>None</p>
|
|
</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li232412420504">Example requests<ol id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ol16377330195711"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1137723020577">Query all VPN gateways.<pre class="screen" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_screen448115167213">GET https://{Endpoint}/v5/{project_id}/vpn-gateways</pre>
|
|
</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li086753145714">Query VPN gateways based on a specified enterprise project ID.<pre class="screen" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_screen93351136202211">GET https://{Endpoint}/v5/{project_id}/vpn-gateways?enterprise_project_id={enterprise_project_id}</pre>
|
|
</li></ol>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul2144514204819"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li61441714114816">Response parameters<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1662611265415"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li61441714114816"></a><a name="en-us_topic_0000001543513480_li61441714114816"></a>Returned status code 200: successful query</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table72042" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response body</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row7627162615416"><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_0000001807530284__en-us_topic_0000001543513480_p186278261444">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p10627526443">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.78%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p176282026047">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row56278261844"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p462817261643">vpn_gateways</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p662819269411">Array of <a href="#EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table92141">ResponseVpnGateway</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.78%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p9628102617413">Specifies gateway Information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row196277261743"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p46282261946">request_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p562982617412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.78%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p126291126945">Specifies a request ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table92141"></a><a name="en-us_topic_0000001543513480_table92141"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table92141" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ResponseVpnGateway</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row169558322489"><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_0000001807530284__en-us_topic_0000001543513480_p0958932134820">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1095913204820">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p795915328484">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row169555324487"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p136518913597">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p66512919596">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul166514995911"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1065179135919">Specifies a VPN gateway ID.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li3656915592">The value is a UUID containing 36 characters.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row1955103214483"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p76520920591">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p76519125915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul96539185910"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li146529185914">Specifies a VPN gateway name. If no VPN gateway name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li06511916595">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row119551332114816"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p8800101572317">network_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p2800191592313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul13252145262311"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li425275211230">Specifies the network type of the VPN gateway.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1325245222313">The value can be <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b2080402295417">public</strong> or <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b9804522135411">private</strong>.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li225215211231">The default value is <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1292315415535">public</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row16957133244815"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p665159155916">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p146520915594">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul8652905916"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1565189115910">Specifies the status of the VPN gateway.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li3655915598">Value range:<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p6652985917"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li3655915598"></a><a name="en-us_topic_0000001543513480_li3655915598"></a><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b101844115549">PENDING_CREATE</strong>: creating</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p46519919598"><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b446673125418">PENDING_UPDATE</strong>: updating</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p16655985912"><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b16243165135410">PENDING_DELETE</strong>: deleting</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p6658917593"><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b18544677548">ACTIVE</strong>: normal</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1366209145916"><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1724920521385">FAULT</strong>: abnormal</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p566179155917"><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b7097092505014">FREEZED</strong>: frozen</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row17957173216487"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p86613913596">attachment_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1566197597">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul11662912595"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li17661794599">Specifies the association mode.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li6662965917">The value can be <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b2657105814384">vpc</strong> or <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b565725893816">er</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row29579324483"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p106616915598">er_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p17661492592">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1066149105917">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_0000001807530284__en-us_topic_0000001543513480_b189740237548">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b5974122318547">er</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row199571328489"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p96617920597">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p196614912595">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p2351172164713">Specifies the ID of the service VPC associated with the VPN gateway. This parameter is returned only when <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b108381673311">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b18838157538">vpc</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row179575323488"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p16610918596">local_subnets</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1066129125910">Array of String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1066291590">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_0000001807530284__en-us_topic_0000001543513480_b64551127115415">attachment_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b15455192715417">vpc</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row1795718320489"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p46649125913">connect_subnet</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p7666965911">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p16617919593">Specifies the ID of the VPC subnet used by the VPN gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row1095773224810"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p5667925919">bgp_asn</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p18661996599">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p866199185913">Specifies the BGP AS number of the VPN gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row5957132154811"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p196689185916">flavor</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p186614975917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul16311126192517"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1131111619251">Specifies the specifications of the VPN gateway.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li138324136257">Value range:<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1824457132913"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li138324136257"></a><a name="en-us_topic_0000001543513480_li138324136257"></a><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b202520362155919">Basic</strong>: The maximum forwarding bandwidth is 100 Mbit/s.</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1570711910299"><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b118141330185410">Professional1</strong>: The maximum forwarding bandwidth is 300 Mbit/s.</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p18706125722515"><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1454954084613">Professional1-NonFixedIP</strong> (not yet supported): The maximum forwarding bandwidth is 300 Mbit/s.</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p114585512299"><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b3399133513545">Professional2</strong>: The maximum forwarding bandwidth is 1 Gbit/s.</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p19778115192613"><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1914195294615">Professional2-NonFixedIP</strong> (not yet supported): The maximum forwarding bandwidth is 1 Gbit/s.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row895716322486"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p966095596">availability_zone_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p266199195913">Array of String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p116615913593">Specifies the AZ where the VPN gateway is deployed. This parameter is available when an AZ is specified. If no AZ is specified, this parameter is available only when the VPN gateway is in ACTIVE state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row19831247124914"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1367711217340">connection_number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p292181374">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1967742133416">Specifies the maximum number of VPN connections supported for the VPN gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row1982413275916"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p7664925913">used_connection_number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p8678920596">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p7671793597">Specifies the number of VPN connections that have been used by the VPN gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row149573323480"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p06789125910">used_connection_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p116719195915">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p15676915918">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_0000001807530284__en-us_topic_0000001543513480_row10957153215482"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p9671195593">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1677910594">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul1767196593"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li96712935914">Specifies an enterprise project ID.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li667797597">The value is a UUID containing 36 characters. If no enterprise project ID is specified during VPN gateway creation, 0 is returned, indicating that the resource belongs to the default enterprise project.<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p19677925918"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li667797597"></a><a name="en-us_topic_0000001543513480_li667797597"></a>Note that 0 is not the ID of an existing enterprise project.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row1395823211489"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p56712955914">eip1</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p167199105911"><a href="#EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table92142">ResponseEip</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1678910593">Specifies the first EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row6958153215489"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p9675914595">eip2</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p36716915592"><a href="#EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table92142">ResponseEip</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p56713916595">Specifies the second EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row8958103213484"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1767997599">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p12679925914">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul1650919597138"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li3509165941315">Specifies the time when the VPN gateway is created. This parameter is available when the VPN gateway is in ACTIVE state.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li167589346205">The UTC time format is <em id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_i3970115163918">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row18731221595"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1667149165915">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p3671098590">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul62639441417"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li326311461414">Specifies the last update time. This parameter is available when the VPN gateway is in ACTIVE state.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_i11638111773919">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row18166233151019"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p155141949131012">lock_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p17514124901018">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p7880165618567">Specifies whether a frozen VPN gateway can be deleted.</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p2105204644819">The value <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b53317878171619">1</strong> indicates that a frozen gateway can be deleted.</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1322722920317">The value <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1888619222370">2</strong> indicates that a frozen gateway cannot be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row3669938131015"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p10515849151018">master_eip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p166282941713">master_eip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p12532752487">Specifies the first EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state.</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p44963582149">This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row122590423108"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p175159499105">slave_eip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1362812991710">slave_eip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p361195591415">Specifies the second EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state.</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p16906348131418">This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row750317451103"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1951574991014">high_availability</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1151516498107">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1311015563918">Specifies the high availability (HA) attribute of the VPN gateway.</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p2051534931019">This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row48161430598"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p896144115225">access_vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p189624116227">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul15906343192415"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li8906114317244">Specifies the ID of the access VPC used by the VPN gateway.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li14906114318244">The value is a UUID containing 36 characters.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row1781918420595"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p153418072512">access_subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p8534170132513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul7121212102510"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1612131216253">Specifies the ID of the subnet in the access VPC used by the VPN gateway.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li312141282510">The value is a UUID containing 36 characters.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row1837418665912"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1549105802613">access_private_ip_1</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p19549165852610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p25491258162611">Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the first private IP address of the VPN gateway in active-active mode or the active private IP address of the VPN gateway in the active-standby mode.</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1866842616281">An example is 192.168.52.9. This parameter is available only when <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b19694138155411">network_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b176949381548">private</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row16415129312"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1188031315114">access_private_ip_2</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1288014137116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p88809138114">Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the second private IP address of the VPN gateway in active-active mode or the standby private IP address of the VPN gateway in the active-standby mode.</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p588011131712">An example is 192.168.52.9. This parameter is available only when <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1371542125411">network_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b137144210540">private</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row19124112215418"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1273517484494">ha_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p128931826204917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul745813232509"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li245822325012">Specifies the HA mode of the gateway. The value can be <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b366305635411">active-active</strong> or <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b18663135616543">active-standby</strong>.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li18458102315013">Value range: active-active, active-standby</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1458102365015">Default value: <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b57210145514">active-active</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row105871816132715"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1674072982719">policy_template</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p5750142932714"><a href="#EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table204661634173912">PolicyTemplate</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p10139121112339">Indicates 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_0000001807530284__en-us_topic_0000001543513480_row4665164714595"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p14785225145413">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p147855259548">Array of <a href="#EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table4138248135518">VpnResourceTag</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1280042717591">Specifies a tag list.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table92142"></a><a name="en-us_topic_0000001543513480_table92142"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table92142" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResponseEip</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row99811932114814"><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_0000001807530284__en-us_topic_0000001543513480_p79821132184812">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1398353219489">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p8984832104813">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row098153216484"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p13619157596">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p83661520598">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul46511446346"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li76516442344">Specifies an EIP ID.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li165344143419">The value is a UUID containing 36 characters. If the default enterprise project is used, 0 is returned.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row1998118326481"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p17371215175916">ip_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p5379151592">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul11582855187"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li11582145519817">Specifies the EIP version.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li20181917911">The value can only be <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b180111818559">4</strong>, indicating IPv4 address.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row098153214483"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p538215105912">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p203801512598">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul17823135518714"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li18823355977">Specifies the EIP type.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li19121931583">For the value range, see the <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b189515406216">type</strong> field in "Assigning an EIP" in the <em id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_i08951940428">Elastic IP API Reference</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row16981143294811"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p17142141545915">ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1714291517592">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul15421714152513"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li154314147253">Specifies an EIP, that is, a public IPv4 address.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li8589191913253">The value is an IPv4 address, for example, 88.***.***.11.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row14981153218484"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1014220157595">charge_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p151421915155915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul1920245802910"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li520275812917">Specifies the bandwidth billing mode of an EIP.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1962150143010">Value range:<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p5507016018"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1962150143010"></a><a name="en-us_topic_0000001543513480_li1962150143010"></a><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1097355219555">traffic</strong>: billed by traffic</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row298103212489"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p2014241555917">bandwidth_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p11142121519594">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul2060210573114"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1060213523118">Specifies the bandwidth ID of an EIP.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li155137173112">The value is a UUID containing 36 characters.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row1098114327482"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p61421315125918">bandwidth_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p51423152595">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul3179104382717"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_li417025410273">The value ranges from 1 to 1000.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row14981632104816"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p2014313153595">bandwidth_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p18143101520593">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul1923211458282"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li923314517284">Specifies the bandwidth name of an EIP.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li14671181410296">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row185137426476"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1712371510330">share_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p71231915103311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul12779104164120"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li117799416413">Specifies the type of EIP bandwidth.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li8779174184111">Value range:<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p109835013465"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li8779174184111"></a><a name="en-us_topic_0000001543513480_li8779174184111"></a><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b11363690276955">WHOLE</strong>: shared bandwidth</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p487612504614"><strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b184842402112">PER</strong>: dedicated bandwidth</p>
|
|
<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p462440454">This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row196301744154710"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p10101184334">network_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p151051813314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul173781526184415"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1237862613444">Specifies the EIP type.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li7378122615447">For the value range of this parameter, see the value range of the <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b184460068463039">type</strong> field in section "Assigning an EIP" in the <em id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_i87575189863039">Elastic IP API Reference</em>.<p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p119221613144511">This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table204661634173912"></a><a name="en-us_topic_0000001543513480_table204661634173912"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table204661634173912" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PolicyTemplate</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_p1546613417392">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_p164664342393"><a href="#EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_p143123388232">Specifies the IKE policy object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_p19533522114210"><a href="#EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_p1499115261518">Specifies the IPsec policy object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table6755101415474"></a><a name="en-us_topic_0000001543513480_table6755101415474"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table6755101415474" frame="border" border="1" rules="all"><caption><b>Table 7 </b>IkePolicy</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_p11755614164713">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_ul7481132141015"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li748172120107">Specifies an encryption algorithm.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li20481192111105">The value can be <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1937875689113154">aes-256-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1352854673113154">aes-128-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1324919353113154">aes-256</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b335779192113154">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1785461755113154">aes-128</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_ul1948182111109"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li28627445718">Specifies the DH group used for key exchange in phase 1.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li14481182121010">The value can be <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b2093595398105831">group14</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1702814154105831">group15</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b530669655105831">group16</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b786772839105831">group19</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b533048374105831">group20</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b220688053105831">group21</strong>, or <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b420480158105831">disable</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_ul11212415102"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li2121184131012">Specifies an authentication algorithm.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li5121941171018">The value can be <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b529647147105845">sha2-512</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1206537244105845">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1151993167105845">sha2-256</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_ul1448120211104"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li648116215104">Specifies the SA lifetime. When the lifetime expires, an IKE SA is automatically updated.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_table1512731654717"></a><a name="en-us_topic_0000001543513480_table1512731654717"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table1512731654717" frame="border" border="1" rules="all"><caption><b>Table 8 </b>IpsecPolicy</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_p1812812163473">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_ul148555357565"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1885518359564">Specifies an authentication algorithm.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li138551835155615">The value can be <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b881569556105845">sha2-512</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1653487846105845">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b864557717105845">sha2-256</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_ul312124112109"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1608112013145">Specifies an encryption algorithm.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li168031229145818">The value can be <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1802387739113154">aes-256-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1092187141113154">aes-128-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b2067666147113154">aes-256</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b395144526113154">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b250773565113154">aes-128</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_ul121216411104"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li312114416109">Specifies the DH key group used by PFS.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li2121194119106">The value can be <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b879917184105831">group14</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b461990018105831">group15</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b447759497105831">group16</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b896562045105831">group19</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b316783403105831">group20</strong>, <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1115425933105831">group21</strong>, or <strong id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_b1517329479105831">disable</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_ul15122541141014"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li18122184110108">Specifies the lifetime of a tunnel established over an IPsec connection.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li412214112104">The value ranges from 30 to 604800, in seconds.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table4138248135518"></a><a name="en-us_topic_0000001543513480_table4138248135518"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_table4138248135518" frame="border" border="1" rules="all"><caption><b>Table 9 </b>VpnResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row313874885517"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.8.2.4.1.1"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p1613864810559">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.009999999999998%" id="mcps1.3.5.2.1.8.2.4.1.2"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p11138114805517">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.769999999999996%" id="mcps1.3.5.2.1.8.2.4.1.3"><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p913874812558">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_row5138148125515"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p86437477589">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p11643144711589">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.8.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul65231833153920"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li1303152053315">Specifies a tag key.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_row16139174885513"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p16643847205814">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.2.1.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p764324795815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.769999999999996%" headers="mcps1.3.5.2.1.8.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ul961219349376"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li5601175311451">Specifies a tag value.</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_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_0000001807530284__en-us_topic_0000001543513480_li1541515719519">Example responses<ol id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ol1699216541350"><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li119922054359">Response to the request for querying all VPN gateways<pre class="screen" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_screen1658863772013">{
|
|
"vpn_gateways": [{
|
|
"id": "8e1d0686-demo-a8df-va86-91f32fa1dfc8",
|
|
"name": "vpngw-1af3",
|
|
"network_type": "public",
|
|
"status": "ACTIVE",
|
|
"attachment_type": "vpc",
|
|
"vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c",
|
|
"local_subnets": ["192.168.15.0/24"],
|
|
"connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"bgp_asn": 64512,
|
|
"flavor": "Professional1",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph540284913236"> "availability_zone_ids": ["eu-de-01", "eu-de-02"],</span>
|
|
"connection_number": 200,
|
|
"used_connection_number": 0,
|
|
"used_connection_group": 0,
|
|
"enterprise_project_id": "0",
|
|
"eip1": {
|
|
"id": "8ff5d6b5-demo-a8df-va86-b9d598033153",
|
|
"ip_version": 4,
|
|
"type": "5_bgp",
|
|
"ip_address": "88.***.***.111",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph1577052263116"> "charge_mode": "traffic",</span>
|
|
"bandwidth_id": "aa62f8f2-demo-a8df-va86-b05b2b999715",
|
|
"bandwidth_size": 300,
|
|
"bandwidth_name": "vpngw-bandwidth-13a3"
|
|
},
|
|
"eip2": {
|
|
"id": "08e7e927-demo-a8df-va86-26a6394021eb",
|
|
"ip_version": 4,
|
|
"type": "5_bgp",
|
|
"ip_address": "88.***.***.199",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph14843124513114"> "charge_mode": "traffic",</span>
|
|
"bandwidth_id": "887d61f7-demo-a8df-va86-38ee8232e27c",
|
|
"bandwidth_size": 300,
|
|
"bandwidth_name": "vpngw-bandwidth-1afb"
|
|
},
|
|
"created_at": "2024-06-28T09:41:11.445Z",
|
|
"updated_at": "2024-06-28T09:41:11.445Z",
|
|
"access_vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c",
|
|
"access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"ha_mode": "active-active"
|
|
}, {
|
|
"id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5",
|
|
"name": "vpngw-2be4",
|
|
"network_type": "public",
|
|
"status": "ACTIVE",
|
|
"attachment_type": "er",
|
|
"er_id": "c62fad0d-demo-a8df-va86-e06c4c351b9f",
|
|
"bgp_asn": 64512,
|
|
"flavor": "Professional1",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph825454352420"> "availability_zone_ids": ["eu-de-01", "eu-de-02"],</span>
|
|
"connection_number": 200,
|
|
"used_connection_number": 0,
|
|
"used_connection_group": 0,
|
|
"enterprise_project_id": "0",
|
|
"eip1": {
|
|
"id": "0f6d1415-demo-a8df-va86-edb2ee97c9cc",
|
|
"ip_version": 4,
|
|
"type": "5_bgp",
|
|
"ip_address": "88.***.***.251",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph183671513113215"> "charge_mode": "traffic",</span>
|
|
"bandwidth_id": "e93767cc-demo-a8df-va86-bac2987f90a4",
|
|
"bandwidth_size": 300,
|
|
"bandwidth_name": "vpngw-bandwidth-10c3"
|
|
},
|
|
"eip2": {
|
|
"id": "7b46b62f-demo-a8df-va86-6b8e44312416",
|
|
"ip_version": 4,
|
|
"type": "5_bgp",
|
|
"ip_address": "88.***.***.102",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph11170132083217"> "charge_mode": "traffic",</span>
|
|
"bandwidth_id": "bde3557e-demo-a8df-va86-629a3754ae07",
|
|
"bandwidth_size": 300,
|
|
"bandwidth_name": "vpngw-bandwidth-18bd",
|
|
},
|
|
"created_at": "2024-06-28T09:41:11.445Z",
|
|
"updated_at": "2024-06-28T09:41:11.445Z",
|
|
"access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
|
|
"access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"ha_mode": "active-active"
|
|
},{
|
|
"id":"66ddeacb-demo-a8df-va86-9a414b5bd7d5",
|
|
"name":"vpngw-5bd6",
|
|
"network_type":"public",
|
|
"status":"ACTIVE",
|
|
"attachment_type":"vpc",
|
|
"vpc_id":"c62fad0d-demo-a8df-va86-e06c4c351b9f",
|
|
"local_subnets":[
|
|
"192.168.0.0/24"
|
|
],
|
|
"connect_subnet":"fd75bf7b--demo-a8df-va86-db13f03e299a",
|
|
"bgp_asn":64512,
|
|
"flavor":"Professional1-NonFixedIP",
|
|
"availability_zone_ids":[
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph17682857163420"> "eu-de-01"</span>
|
|
],
|
|
"connection_number":200,
|
|
"used_connection_number":0,
|
|
"used_connection_group":0,
|
|
"enterprise_project_id":"0",
|
|
"ha_mode":"active-standby",
|
|
"eip1":{
|
|
"id":"0f6d1415-demo-a8df-va86-edb2ee97c9cc",
|
|
"ip_version":4,
|
|
"type":"5_bgp",
|
|
"ip_address":"88.***.***.251",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph11509347123212"> "charge_mode": "traffic",</span>
|
|
"bandwidth_id":"e93767cc-demo-a8df-va86-bac2987f90a4",
|
|
"bandwidth_size":300,
|
|
"bandwidth_name":"vpngw-bandwidth-10c3"
|
|
},
|
|
"eip2":{
|
|
"id":"7b46b62f-demo-a8df-va86-6b8e44312416",
|
|
"ip_version":4,
|
|
"type":"5_bgp",
|
|
"ip_address":"88.***.***.102",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph5160115463214"> "charge_mode": "traffic",</span>
|
|
"bandwidth_id":"bde3557e-demo-a8df-va86-629a3754ae07",
|
|
"bandwidth_size":300,
|
|
"bandwidth_name":"vpngw-bandwidth-18bd"
|
|
},
|
|
"policy_template":{
|
|
"ike_policy":{
|
|
"encryption_algorithm":"aes-128",
|
|
"dh_group":"group20",
|
|
"authentication_algorithm":"sha2-256",
|
|
"lifetime_seconds":86400
|
|
},
|
|
"ipsec_policy":{
|
|
"authentication_algorithm":"sha2-256",
|
|
"encryption_algorithm":"aes-128",
|
|
"pfs":"group20",
|
|
"lifetime_seconds":3600
|
|
}
|
|
},
|
|
"created_at":"2024-06-28T09:41:11.445Z",
|
|
"updated_at":"2024-06-28T09:41:11.445Z",
|
|
"access_vpc_id":"4d03fe2d--demo-a8df-va86-6def96440f2b",
|
|
"access_subnet_id":"fd75bf7b--demo-a8df-va86-e-db13f03e299a"
|
|
}],
|
|
"request_id": "de1b6caf-d024-4dac-850e-645af40c84f3"
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_li13552411661">Response to the request for querying VPN gateways based on a specified enterprise project ID<pre class="screen" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_screen12423204114293">{
|
|
"vpn_gateways": [{
|
|
"id": "8e1d0686-demo-a8df-va86-91f32fa1dfc8",
|
|
"name": "vpngw-1af3",
|
|
"network_type": "public",
|
|
"status": "ACTIVE",
|
|
"attachment_type": "vpc",
|
|
"vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c",
|
|
"local_subnets": ["192.168.15.0/24"],
|
|
"connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"bgp_asn": 64512,
|
|
"flavor": "Professional1",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph66849116253"> "availability_zone_ids": ["eu-de-01", "eu-de-02"],</span>
|
|
"connection_number": 200,
|
|
"used_connection_number": 0,
|
|
"used_connection_group": 0,
|
|
"enterprise_project_id": "7354dda9-demo-a8df-va86-a6b08fb92043",
|
|
"eip1": {
|
|
"id": "8ff5d6b5-demo-a8df-va86-b9d598033153",
|
|
"ip_version": 4,
|
|
"type": "5_bgp",
|
|
"ip_address": "88.***.***.111",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph942901012335"> "charge_mode": "traffic",</span>
|
|
"bandwidth_id": "aa62f8f2-demo-a8df-va86-b05b2b999715",
|
|
"bandwidth_size": 300,
|
|
"bandwidth_name": "vpngw-bandwidth-13a3"
|
|
},
|
|
"eip2": {
|
|
"id": "08e7e927-demo-a8df-va86-26a6394021eb",
|
|
"ip_version": 4,
|
|
"type": "5_bgp",
|
|
"ip_address": "88.***.***.199",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph1679144913332"> "charge_mode": "traffic",</span>
|
|
"bandwidth_id": "887d61f7-demo-a8df-va86-38ee8232e27c",
|
|
"bandwidth_size": 300,
|
|
"bandwidth_name": "vpngw-bandwidth-1afb"
|
|
},
|
|
"created_at": "2024-06-28T09:41:11.445Z",
|
|
"updated_at": "2024-06-28T09:41:11.445Z",
|
|
"access_vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c",
|
|
"access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"ha_mode": "active-active"
|
|
}, {
|
|
"id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5",
|
|
"name": "vpngw-2be4",
|
|
"network_type": "private",
|
|
"status": "ACTIVE",
|
|
"attachment_type": "er",
|
|
"er_id": "c62fad0d-demo-a8df-va86-e06c4c351b9f",
|
|
"bgp_asn": 64512,
|
|
"flavor": "Professional1",
|
|
<span id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_ph197379302612"> "availability_zone_ids": ["eu-de-01", "eu-de-02"],</span>
|
|
"connection_number": 200,
|
|
"used_connection_number": 0,
|
|
"used_connection_group": 0,
|
|
"enterprise_project_id": "7354dda9-demo-a8df-va86-a6b08fb92043",
|
|
"access_private_ip_1": "192.168.4.7",
|
|
"access_private_ip_2": "192.168.4.99",
|
|
"created_at": "2024-06-28T09:41:11.445Z",
|
|
"updated_at": "2024-06-28T09:41:11.445Z",
|
|
"access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
|
|
"access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
|
|
"ha_mode": "active-active"
|
|
}
|
|
],
|
|
"request_id": "bfa819a1-e824-4799-8e72-21a35dad97c9"
|
|
}</pre>
|
|
</li></ol>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001807530284__en-us_topic_0000001543513480_p290319447412">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>
|
|
|