vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpn/api-ref/vpn_api_0029.html
Hongwei, King Wang 32c06a10a2 vpn_api 
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>
2024-08-15 14:18:28 +00:00

925 lines
98 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001807530300"></a><a name="EN-US_TOPIC_0000001807530300"></a>
<h1 class="topictitle1">Querying the VPN Connection List</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p21311124201216">This API is used to query the VPN connection list.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p186801950113213">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_0000001807530300__en-us_topic_0000001594472953_section46808346"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p4500129205218">GET /v5/{project_id}/vpn-connection</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table3672032" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_p43154149">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row5825185"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_p98501361516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row13655521164"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1735017031614">vgw_ip</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p884793841616">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p7847133811168">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_0000001807530300__en-us_topic_0000001594472953_p53503018160">Specifies an EIP ID or private IP address of a VPN gateway.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row4350150201611"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p2092664112178">vgw_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_0000001807530300__en-us_topic_0000001594472953_p72873681814">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p172874681815">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_0000001807530300__en-us_topic_0000001594472953_p1923184131719">Specifies a VPN gateway ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row151641552155"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_p165561753817">Specifies an enterprise project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row98491230158"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p7853153151517">limit</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p385373121518">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p98531631159">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul12256122111619"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li12256192117612">Specifies the number of records returned on each page during pagination query.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li198991840162">The value ranges from 0 to 200.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li17256221369">The default value is 200.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row184963191517"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p98548351517">marker</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p5854932150">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p685418314158">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul471410271073"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li157141327871">Specifies the start flag for querying the current page. If this parameter is left blank, the first page is queried. The <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b149340058193547">marker</strong> for querying the next page is the <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b133289268093547">next_marker</strong> in the <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b4721123993547">page_info</strong> object returned on the current page.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li11300164817712">This parameter must be used together with <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b6981866803518">limit</strong>.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul5992193374713"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1499317417136">Request parameters<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p203461442181314"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1499317417136"></a><a name="en-us_topic_0000001594472953_li1499317417136"></a>None</p>
</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li12919134215016">Example requests<ol id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ol1556918112816"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li3570161111815">Query all VPN connections.<pre class="screen" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_screen7134115412415">GET https://{Endpoint}/v5/{project_id}/vpn-connection</pre>
</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1159642215819">Query VPN connections of a specified vgw_ip.<pre class="screen" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_screen17274112614331">GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_ip={vgw_ip}&amp;limit={limit}&amp;marker={marker}</pre>
</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li126968517810">Query VPN connections of a specified VPN gateway instance.<pre class="screen" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_screen1381911172219">GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_id={vgw_id}&amp;limit={limit}&amp;marker={marker}</pre>
</li></ol>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul2144514204819"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li61441714114816">Response parameters<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p2141324201215"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li61441714114816"></a><a name="en-us_topic_0000001594472953_li61441714114816"></a>Returned status code 200: successful operation</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92785" 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_0000001807530300__en-us_topic_0000001594472953_row14859153181520"><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_0000001807530300__en-us_topic_0000001594472953_p128591331157">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p108597311510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1986016314156">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row68591831158"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p38606313151">vpn_connections</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1786013318159">Array of</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p191965123202"><a href="#EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92786">ResponseVpnConnection</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p48601632151">Specifies the VPN connection object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row9859173121515"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p88607316153">page_info</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p28611638153"><a href="#EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92787">PageInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p8932156142812">Specifies pagination information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row48591734154"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1086117301516">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p18611436158">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p15861830151">Specifies a request ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row11859038153"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p186212361510">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p148621037154">Long</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p186218381512">Specifies the total number of a tenant's connections.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92786"></a><a name="en-us_topic_0000001594472953_table92786"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92786" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ResponseVpnConnection</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row178631320154"><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_0000001807530300__en-us_topic_0000001594472953_p174814101518">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_0000001807530300__en-us_topic_0000001594472953_p44814410153">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_0000001807530300__en-us_topic_0000001594472953_p134818417159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row68633321514"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1499481515">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_0000001807530300__en-us_topic_0000001594472953_p1849240155">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_0000001807530300__en-us_topic_0000001594472953_ul1064673414438"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li4646123404312">Specifies a VPN connection ID.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li2044713122414">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row198633311157"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p949442155">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_0000001807530300__en-us_topic_0000001594472953_p125020411155">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_0000001807530300__en-us_topic_0000001594472953_ul1257530132415"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li984125514435">Specifies a VPN connection name. If no VPN connection name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li05751408249">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_0000001807530300__en-us_topic_0000001594472953_row178631439150"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p15013411517">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_0000001807530300__en-us_topic_0000001594472953_p2505471516">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_0000001807530300__en-us_topic_0000001594472953_ul119317517446"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li17931115154418">Specifies the status of the VPN connection.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1229019710442">Value range:<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p2179144614349"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1229019710442"></a><a name="en-us_topic_0000001594472953_li1229019710442"></a><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b91321212110319">ERROR</strong>: abnormal</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1421515147359"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b46474116905013">ACTIVE</strong>: normal</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p825913614377"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b72026593110333">DOWN</strong>: not connected</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p628116353"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b126508489804950">PENDING_CREATE</strong>: creating</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p19268028193515"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1629295510453">PENDING_UPDATE</strong>: updating</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p15288137143515"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b167919855023853">PENDING_DELETE</strong>: deleting</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p15682258231"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b39187116244643">FREEZED</strong>: frozen</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p6318164063416"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b201415419464">UNKNOWN</strong>: unknown</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row128631638151"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1051544158">vgw_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_0000001807530300__en-us_topic_0000001594472953_p15519421510">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_0000001807530300__en-us_topic_0000001594472953_ul897315513244"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li13973154244">Specifies a VPN gateway ID.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li91977350441">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row208631371519"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p95218412159">vgw_ip</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_0000001807530300__en-us_topic_0000001594472953_p19525471512">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_0000001807530300__en-us_topic_0000001594472953_ul19318939192411"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1731873912414">Specifies an EIP ID or private IP address of the VPN gateway.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li18371441122415">The value is a UUID containing 36 characters or an IPv4 address in dotted decimal notation (for example, 192.168.45.7).</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row486303161520"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p85344181520">style</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_0000001807530300__en-us_topic_0000001594472953_p15317414151">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_0000001807530300__en-us_topic_0000001594472953_ul97381430161412"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li17381830121413">Specifies the connection mode.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li106691158111412">Value range:<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1597143419533"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li106691158111412"></a><a name="en-us_topic_0000001594472953_li106691158111412"></a><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b186149062765430">POLICY</strong>: policy-based mode</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1497133445316"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b65004359410432">STATIC</strong>: static routing mode</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p19971153485311"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b18213980565438">BGP</strong>: BGP routing mode</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p62291117128"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b550539524111633">POLICY-TEMPLATE</strong>: policy template mode</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row686303121517"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p3554410158">cgw_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_0000001807530300__en-us_topic_0000001594472953_p165516414151">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_0000001807530300__en-us_topic_0000001594472953_ul18590024121317"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li117211751101313">Specifies a customer gateway ID.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li9590152415133">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row78635301516"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p155612419157">peer_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_0000001807530300__en-us_topic_0000001594472953_p1256541150">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_0000001807530300__en-us_topic_0000001594472953_p697242016434">Specifies a customer subnet. This parameter is not returned when the association mode of the VPN gateway is <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1422065754516">ER</strong> and <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b622125754518">style</strong> is <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b3221135744520">BGP</strong> or <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b14221165717453">POLICY</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row128638311151"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p12568401517">tunnel_local_address</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_0000001807530300__en-us_topic_0000001594472953_p11561411512">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_0000001807530300__en-us_topic_0000001594472953_p1547512912514">Specifies the tunnel interface address configured on the VPN gateway in route-based mode. This parameter is valid only when <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b214659727965624">style</strong> is <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b19085846365624">STATIC</strong> or <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b203017670765624">BGP</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row68637331513"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p15571410157">tunnel_peer_address</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_0000001807530300__en-us_topic_0000001594472953_p157104111511">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_0000001807530300__en-us_topic_0000001594472953_p847519295511">Specifies the tunnel interface address configured on the customer gateway device in route-based mode. This parameter is valid only when <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b168510911965624">style</strong> is <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b24077728265624">STATIC</strong> or <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b135867355165624">BGP</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row1086316314157"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p17575417157">enable_nqa</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_0000001807530300__en-us_topic_0000001594472953_p13584491510">Boolean</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_0000001807530300__en-us_topic_0000001594472953_ul5337132316265"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1266518506914">Specifies whether NQA is enabled. This parameter is returned only when <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b40294019835848">style</strong> is <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b78196948835848">STATIC</strong>.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1665950492">The value can be <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b127126354535931">true</strong> or <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b151645025135931">false</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row586343131513"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1458645150">policy_rules</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_0000001807530300__en-us_topic_0000001594472953_p35819421511">Array of <a href="#EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92788">PolicyRule</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_0000001807530300__en-us_topic_0000001594472953_p1247510294516">Specifies policy rules, which are returned only when <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b45132071111525">style</strong> is set to <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1742530138111525">POLICY</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row68631437152"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1459124151518">ikepolicy</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_0000001807530300__en-us_topic_0000001594472953_p1510765064813"><a href="#EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92789">IkePolicy</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_0000001807530300__en-us_topic_0000001594472953_p03543072813">Specifies the IKE policy object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row28635320153"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p35910415159">ipsecpolicy</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_0000001807530300__en-us_topic_0000001594472953_p01096501487"><a href="#EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92790">IpsecPolicy</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_0000001807530300__en-us_topic_0000001594472953_p1635230112813">Specifies the IPsec policy object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row1586319391515"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p15601244156">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_0000001807530300__en-us_topic_0000001594472953_p17604416155">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_0000001807530300__en-us_topic_0000001594472953_ul17753122932410"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li16767113292415">Specifies the time when the VPN connection is created.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1175452912414">The UTC time format is <em id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_i167543643733936">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row1486319315156"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p126114101513">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_0000001807530300__en-us_topic_0000001594472953_p661184161516">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_0000001807530300__en-us_topic_0000001594472953_ul6106151392213"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1876773217242">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_i84082787433936">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row5863133121519"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p136111441512">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_0000001807530300__en-us_topic_0000001594472953_p1061134131519">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_0000001807530300__en-us_topic_0000001594472953_ul1346517119494"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1243612127408">Specifies an enterprise project ID.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li144651611124913">The value is a UUID containing 36 characters. The value must be the same as the enterprise project ID of the VPN gateway specified by <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b93331407495427">vgw_id</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row6181140104019"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p3688384332">connection_monitor_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_0000001807530300__en-us_topic_0000001594472953_p12688148193319">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_0000001807530300__en-us_topic_0000001594472953_ul1660883211364"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1660823223617">Specifies the ID of a VPN connection monitor. This parameter is available only when a connection monitor is created for a VPN connection.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1960815325369">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row11957482468"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1316114817376">ha_role</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_0000001807530300__en-us_topic_0000001594472953_p9161048193716">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_0000001807530300__en-us_topic_0000001594472953_ul516134823715"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li816124833714">For a VPN gateway in active-standby mode, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b186743537253342">master</strong> indicates the active connection, and <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b114985128153342">slave</strong> indicates the standby connection. For a VPN gateway in active-active mode, the value of <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b29278947853422">ha_role</strong> can only be <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b6816055553422">master</strong>.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1516144819375">The default value is <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b77708832652725">master</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row1126533264413"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_p147855259548">Array of <a href="#EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_p1280042717591">Specifies a tag list.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row0443457115215"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p197601059134318">eip_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_0000001807530300__en-us_topic_0000001594472953_p20848192034414">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_0000001807530300__en-us_topic_0000001594472953_ul5536750154420"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li05361450114414">Specifies an EIP ID or private IP address of the VPN gateway.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li15536115074411">The value is a UUID containing 36 characters or an IPv4 address in dotted decimal notation (for example, 192.168.45.7).<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p44963582149"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li15536115074411"></a><a name="en-us_topic_0000001594472953_li15536115074411"></a>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_0000001807530300__en-us_topic_0000001594472953_row12697502535"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p16179152174410">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_0000001807530300__en-us_topic_0000001594472953_p12179222448">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_0000001807530300__en-us_topic_0000001594472953_ul106464105013"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li116594175020">Specifies the connection mode.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li196594185014">Value range:<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p96514185013"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li196594185014"></a><a name="en-us_topic_0000001594472953_li196594185014"></a><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b211157438071738">POLICY</strong>: policy-based mode</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p176564125020"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b22275740271753">ROUTE</strong>: routing mode</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p184041030185010">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_0000001807530300__en-us_topic_0000001594472953_row12351628534"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p15971555174318">route_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_0000001807530300__en-us_topic_0000001594472953_p85971554431">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_0000001807530300__en-us_topic_0000001594472953_ul6822164365013"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li582204305020">Specifies the routing mode.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li16822114385020">Value range:<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p0822043105010"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li16822114385020"></a><a name="en-us_topic_0000001594472953_li16822114385020"></a><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b12614531807181">static</strong>: static routing mode</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p182284315013"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b867491914189">bgp</strong>: BGP routing mode</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p138221843105016">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_0000001807530300__en-us_topic_0000001594472953_table92788"></a><a name="en-us_topic_0000001594472953_table92788"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92788" frame="border" border="1" rules="all"><caption><b>Table 5 </b>PolicyRule</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row2087863191510"><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_0000001807530300__en-us_topic_0000001594472953_p264194121514">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_0000001807530300__en-us_topic_0000001594472953_p20646413153">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_0000001807530300__en-us_topic_0000001594472953_p16415417157">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row587818313159"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1264134121516">rule_index</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_0000001807530300__en-us_topic_0000001594472953_p1865649154">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_0000001807530300__en-us_topic_0000001594472953_ul31891344132814"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1918954413287">Specifies a rule ID.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li197041251162810">The value ranges from 0 to 50.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row128785311516"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p86594111515">source</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_0000001807530300__en-us_topic_0000001594472953_p1265164141514">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1847620291056">Specifies a source CIDR block.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row2878133171511"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p86620418150">destination</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_0000001807530300__en-us_topic_0000001594472953_p266546151">Array of String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1457013454314">Specifies a destination CIDR block. For example, a destination CIDR block can be 192.168.52.0/24. A maximum of 50 destination CIDR blocks can be returned for each policy rule.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92789"></a><a name="en-us_topic_0000001594472953_table92789"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92789" frame="border" border="1" rules="all"><caption><b>Table 6 </b>IkePolicy</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row118811339152"><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_0000001807530300__en-us_topic_0000001594472953_p8688401513">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.5.2.4.1.2"><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p146894101520">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.5.2.4.1.3"><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p10684420159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row188811314151"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p126811418153">ike_version</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p36914161510">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul162887853418"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li11288384341">Specifies the IKE version.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li121218100348">The value can be <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b45277625245321">v1</strong> or <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b158016747145321">v2</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row688120310159"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p67018411155">phase1_negotiation_mode</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p13707451515">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul1940203911342"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li19414438348">Specifies the negotiation mode. This parameter is available only when the IKE version is <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b3848652747158">v1</strong>.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1840418154818">Value range:<ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul38443441458"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li57271943124510"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b4399523177218">main</strong>: ensures high security during negotiation.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1173918433458"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1612409079101354">aggressive</strong>: ensures fast negotiation and a high negotiation success rate.</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row1588123171517"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p15714481512">authentication_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p47134141518">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul17478132133519"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1368346062">Specifies an authentication algorithm.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li84782219355">The value can be <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1789735693217">sha2-512</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b38972056113217">sha2-384</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1389715619324">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b19897156113213">sha1</strong>, or <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b12897145620323">md5</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row2881193191510"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p25391541151">encryption_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1653974121514">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul55059257363"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li350542515364">Specifies an encryption algorithm.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li756133143611">The value can be <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b171941559193212">aes-256-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b619415963212">aes-128-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b819425953212">aes-256</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b41948594328">aes-192</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b2019575923212">aes-128</strong>, or <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b12195125963219">3des</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row98811635155"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p34687292517">dh_group</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p25403414157">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul551518553814"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li14515165133817">Specifies the DH group used for key exchange in phase 1. </li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li54682070387">The value can be <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b146218102652228">group1</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b88377282652228">group2</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b46918663152228">group5</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b4222418552228">group14</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b183144160752228">group15</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b85923158952228">group16</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b28743430852228">group19</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b82763465152228">group20</strong>, or <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b27646530652228">group21</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row588212311156"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p145411842157">authentication_method</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p17541164201515">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul1581114202398"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li208111720173920">Specifies the authentication method used during IKE negotiation.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li152260571264">Value range:<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p618175810611"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li152260571264"></a><a name="en-us_topic_0000001594472953_li152260571264"></a><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b2253660152333">pre-share</strong>: pre-shared key</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row488215371510"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1546813295513">lifetime_seconds</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p54681292512">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul1080514275402"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li9805132724020">Specifies the SA lifetime. When the lifetime expires, an IKE SA is automatically updated.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li14636173511403">The value ranges from 60 to 604800, in seconds.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row1088220341514"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p11469129653">local_id_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p14469172917515">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul1823815102417"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li52381810134118">Specifies the local ID type. </li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li166921028105220">Value range:<ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul219783218523"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li168791526195220">ip</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li72203585219">fqdn (currently not supported)</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row488283181514"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p124691292057">local_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1946914291054">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1182183913526">Specifies the local ID. When <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b103041517161818">local_id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b4304917131813">ip</strong>, the VPN gateway IP address corresponding to the VPN connection is returned. When <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1630481718187">local_id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1230510179188">fqdn</strong>, the local ID specified during VPN connection creation or update is returned.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row128821036157"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p646911291157">peer_id_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1346922916511">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul6534115182915"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li19534195102916">Specifies the peer ID type. </li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li161879509533">Value range:<ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul1118715045315"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1018725012531">ip</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li518835020539">fqdn (currently not supported)</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row98821533159"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1946910291359">peer_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p104698294515">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p310091716567">Specifies the peer ID. When <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b827018202188">peer_id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b72701200183">ip</strong>, the IP address of the customer gateway is returned. When <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b192708201186">peer_id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b2027011206180">fqdn</strong>, the peer ID specified during VPN connection creation or update is returned.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row48824301511"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1944314419151">dpd</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p108031287216"><a href="#EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92792">Dpd</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p25441143154">Specifies the DPD object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92792"></a><a name="en-us_topic_0000001594472953_table92792"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92792" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Dpd</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row178921320153"><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_0000001807530300__en-us_topic_0000001594472953_p1654416415153">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.6.2.4.1.2"><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p05447451512">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.6.2.4.1.3"><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p85442461513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row2893123191520"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p154771612141511">timeout</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p16477512111512">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.6.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul114771912101513"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1947719123158">Specifies the interval for retransmitting DPD packets.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li15477612191517">The value ranges from 2 to 60, in seconds.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row1589316321512"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p84703296515">interval</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p847012293517">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.6.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul177072019154313"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li2070751984314">Specifies the DPD idle timeout period.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li19462110431">The value ranges from 10 to 3600, in seconds.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row158933310155"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p34702029055">msg</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1447017294519">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.6.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul158125219446"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li897532204516">Specifies the format of DPD packets.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1284051412717">Value range:<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p114862251076"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1284051412717"></a><a name="en-us_topic_0000001594472953_li1284051412717"></a><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b71467286664517">seq-hash-notify</strong>: indicates that the payload of DPD packets is in the sequence of hash-notify.</p>
<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p99061371978"><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b124062174794739">seq-notify-hash</strong>: indicates that the payload of DPD packets is in the sequence of notify-hash.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92790"></a><a name="en-us_topic_0000001594472953_table92790"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92790" frame="border" border="1" rules="all"><caption><b>Table 8 </b>IpsecPolicy</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row28953319158"><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_0000001807530300__en-us_topic_0000001594472953_p3546164151516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.7.2.4.1.2"><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p195468491513">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.7.2.4.1.3"><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p11546347151">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row1489614311512"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p185461348159">authentication_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p16546124191515">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul1250214005118"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li7907163744912">Specifies an authentication algorithm.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li109073377499">The value can be <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b365725113339">sha2-512</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b66571512333">sha2-384</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b865717511333">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1665745118337">sha1</strong>, or <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b7657551113315">md5</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row18896123191518"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1054784191516">encryption_algorithm</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p15547144171516">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul125025401511"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1608112013145">Specifies an encryption algorithm.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li8416185984916">The value can be <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1633615546331">aes-256-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1233605415335">aes-128-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1033616549331">aes-256</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b163376546337">aes-192</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b733795417332">aes-128</strong>, or <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1733712547332">3des</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row18965381513"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p17548184141520">pfs</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p145481342154">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul1031211105469"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1431281044611">Specifies the DH key group used by PFS. </li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li6312191064619">The value can be <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b3230658764626">group1</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b172709556664626">group2</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b22352371664626">group5</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b167230986464626">group14</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b8461457164626">group15</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b174587266364626">group16</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b188492364964626">group19</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b201531681464626">group20</strong>, <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b63156829164626">group21</strong>, or <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b83915862364626">disable</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row1889610391516"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p4549741159">transform_protocol</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p14549741158">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul13678851104610"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li17678165154616">Specifies the transfer protocol.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1482613195504">Value range:<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p3444122735018"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1482613195504"></a><a name="en-us_topic_0000001594472953_li1482613195504"></a><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b189688020310150">esp</strong>: encapsulating security payload protocol</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row28961631158"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1946512291654">lifetime_seconds</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p146520291957">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul167218134477"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li15720133479">Specifies the lifetime of a tunnel established over an IPsec connection.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li0903114144715">The value ranges from 30 to 604800, in seconds.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row18965371519"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p20466192910510">encapsulation_mode</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p1146672916514">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ul1851117194911"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li4463194741413">Specifies the packet encapsulation mode.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1149413505145">Value range:<p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p19823165120146"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1149413505145"></a><a name="en-us_topic_0000001594472953_li1149413505145"></a><strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b84094056865150">tunnel</strong>: encapsulates packets in tunnel mode.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table4138248135518"></a><a name="en-us_topic_0000001594472953_table4138248135518"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table4138248135518" frame="border" border="1" rules="all"><caption><b>Table 9 </b>VpnResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_p913874812558">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_p121761293375">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_0000001807530300__en-us_topic_0000001594472953_p41771729153718">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_0000001807530300__en-us_topic_0000001594472953_ul4177729133712"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1217762923713">Specifies a tag key.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li41771629103713">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_0000001807530300__en-us_topic_0000001594472953_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_0000001807530300__en-us_topic_0000001594472953_p171774293371">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_0000001807530300__en-us_topic_0000001594472953_p1617782919374">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_0000001807530300__en-us_topic_0000001594472953_ul10177112943717"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li1917702915375">Specifies a tag value.</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li11177152993718">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_0000001807530300__en-us_topic_0000001594472953_table92787"></a><a name="en-us_topic_0000001594472953_table92787"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_table92787" frame="border" border="1" rules="all"><caption><b>Table 10 </b>PageInfo</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row1590511317152"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.9.2.4.1.1"><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p345011451519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.9.2.4.1.2"><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p145017461514">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.9.2.4.1.3"><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p2450244156">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row6905731158"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p6450154181517">next_marker</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p204509411154">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p131441326122812">Specifies the marker of the next page. The value is the time when the last resource in the last query response was created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_row1690511319157"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p345014141517">current_count</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p545018410154">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_p14145142682820">Specifies the number of resources in the list. If the value of <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b1996615256365">current_count</strong> is less than the value of <strong id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_b159663258364">limit</strong> in the query request, the current page is the last page.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li18761161112">Example responses<ol id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_ol10946152612419"><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li10946926174120">Response to the request for querying all VPN connections<pre class="screen" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_screen20141147103916">{
"vpn_connections": [{
"id": "228a68f0-demo-a8df-va86-a9919a3ea3de",
"name": "vpn-56ea",
"status": "DOWN",
"vgw_id": "ba90819b-demo-a8df-va86-3a01622856a5",
"vgw_ip": "3ea3b006-demo-a8df-va86-ae180ae07885",
"style": "STATIC",
"cgw_id": "537d9c26-demo-a8df-va86-99364a410f00",
"peer_subnets": [
"192.168.1.0/24"
],
"tunnel_local_address": "169.254.149.2/30",
"tunnel_peer_address": "169.254.149.1/30",
"enable_nqa": true,
"ikepolicy": {
"ike_version": "v2",
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"dh_group": "group15",
"authentication_method": "pre-share",
"lifetime_seconds": 86400,
"local_id_type": "ip",
"local_id": "10.1.1.216",
"peer_id_type": "ip",
"peer_id": "10.0.1.67",
"dpd": {
"timeout": 15,
"interval": 30,
"msg": "seq-hash-notify"
}
},
"ipsecpolicy": {
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"pfs": "group15",
"transform_protocol": "esp",
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
"created_at": "2024-06-28T09:41:11.445Z",
"updated_at": "2024-06-28T09:41:11.445Z",
"enterprise_project_id": "0"
},
{
"id": "a4df33ca-demo-a8df-va86-410a7dd6973f",
"name": "vpn-15ea",
"status": "DOWN",
"vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2",
"vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525",
"style": "POLICY",
"cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33",
"tunnel_local_address": "169.254.77.169/30",
"tunnel_peer_address": "169.254.77.170/30",
"policy_rules": [{
"rule_index": 1,
"source": "10.0.0.0/24",
"destination": [
"192.168.44.0/24"
]
}],
"ikepolicy": {
"ike_version": "v2",
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"dh_group": "group15",
"authentication_method": "pre-share",
"lifetime_seconds": 3600,
"local_id_type": "ip",
"local_id": "88.88.201.167",
"peer_id_type": "ip",
"peer_id": "10.111.222.21",
"dpd": {
"interval": 30,
"timeout": 15,
"msg": "seq-hash-notify"
}
},
"ipsecpolicy": {
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"pfs": "group15",
"transform_protocol": "esp",
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
"created_at": "2024-06-28T07:24:27.674Z",
"updated_at": "2024-06-28T07:24:27.674Z",
"enterprise_project_id": "0",
"ha_role":"master"
}
],
"page_info": {
"next_marker": "2024-06-28T07:24:27.674Z",
"current_count": 2
},
"request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
"total_count": 2
}</pre>
</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li21591041114111">Response to the request for querying VPN connections with a specified vgw_ip<pre class="screen" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_screen020424632310">{
"vpn_connections": [
{
"id": "8fa335dd-demo-a8df-va86-78bb55a8bb04",
"name": "vpn-2acd",
"status": "DOWN",
"vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2",
"vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525",
"style": "STATIC",
"cgw_id": "eba04567-demo-a8df-va86-5b0352f89af0",
"peer_subnets": [
"192.168.44.0/24"
],
"tunnel_local_address": "169.254.58.225/30",
"tunnel_peer_address": "169.254.58.226/30",
"enable_nqa": false,
"ikepolicy": {
"ike_version": "v2",
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"dh_group": "group15",
"authentication_method": "pre-share",
"lifetime_seconds": 3600,
"local_id_type": "ip",
"local_id": "88.***.***.167",
"peer_id_type": "ip",
"peer_id": "10.***.***.9",
"dpd": {
"timeout": 15,
"interval": 30,
"msg": "seq-hash-notify"
}
},
"ipsecpolicy": {
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"pfs": "group15",
"transform_protocol": "esp",
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
"created_at": "2024-06-28T14:24:25.115Z",
"updated_at": "2024-06-28T14:24:25.115Z",
"enterprise_project_id": "0"
},
{
"id": "a4df33ca-demo-a8df-va86-410a7dd6973f",
"name": "vpn-15ea",
"status": "DOWN",
"vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2",
"vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525",
"style": "POLICY",
"cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33",
"tunnel_local_address": "169.254.77.169/30",
"tunnel_peer_address": "169.254.77.170/30",
"policy_rules": [
{
"rule_index": 1,
"source": "10.0.0.0/24",
"destination": [
"192.168.44.0/24"
]
}
],
"ikepolicy": {
"ike_version": "v2",
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"dh_group": "group15",
"authentication_method": "pre-share",
"lifetime_seconds": 3600,
"local_id_type": "ip",
"local_id": "88.88.201.167",
"peer_id_type": "ip",
"peer_id": "10.111.222.21",
"dpd": {
"interval": 30,
"timeout": 15,
"msg": "seq-hash-notify"
}
},
"ipsecpolicy": {
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"pfs": "group15",
"transform_protocol": "esp",
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
"created_at": "2024-06-28T13:59:59.633Z",
"updated_at": "2024-06-28T13:59:59.633Z",
"enterprise_project_id": "0",
"ha_role":"master"
}
],
"page_info": {
"next_marker": "2024-06-28T13:59:59.633Z",
"current_count": 2
},
"request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
"total_count": 12
}</pre>
</li><li id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_li10478144124215">Response to the request for querying VPN connections of a specified VPN gateway instance<pre class="screen" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_screen863417148407">{
"vpn_connections": [
{
"id": "8fa335dd-demo-a8df-va86-78bb55a8bb04",
"name": "vpn-2acd",
"status": "DOWN",
"vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2",
"vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525",
"style": "STATIC",
"cgw_id": "eba04567-demo-a8df-va86-5b0352f89af0",
"peer_subnets": [
"192.168.44.0/24"
],
"tunnel_local_address": "169.254.58.225/30",
"tunnel_peer_address": "169.254.58.226/30",
"enable_nqa": false,
"ikepolicy": {
"ike_version": "v2",
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"dh_group": "group15",
"authentication_method": "pre-share",
"lifetime_seconds": 3600,
"local_id_type": "ip",
"local_id": "88.***.***.167",
"peer_id_type": "ip",
"peer_id": "10.***.***.9",
"dpd": {
"timeout": 15,
"interval": 30,
"msg": "seq-hash-notify"
}
},
"ipsecpolicy": {
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"pfs": "group15",
"transform_protocol": "esp",
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
"created_at": "2024-06-28T14:24:25.115Z",
"updated_at": "2024-06-28T14:24:25.115Z",
"enterprise_project_id": "0",
"ha_role":"master"
},
{
"id": "a4df33ca-demo-a8df-va86-410a7dd6973f",
"name": "vpn-15ea",
"status": "DOWN",
"vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2",
"vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525",
"style": "POLICY",
"cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33",
"tunnel_local_address": "169.254.77.169/30",
"tunnel_peer_address": "169.254.77.170/30",
"policy_rules": [
{
"rule_index": 1,
"source": "10.0.0.0/24",
"destination": [
"192.168.44.0/24"
]
}
],
"ikepolicy": {
"ike_version": "v2",
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"dh_group": "group15",
"authentication_method": "pre-share",
"lifetime_seconds": 3600,
"local_id_type": "ip",
"local_id": "88.88.201.167",
"peer_id_type": "ip",
"peer_id": "10.111.222.21",
"dpd": {
"interval": 30,
"timeout": 15,
"msg": "seq-hash-notify"
}
},
"ipsecpolicy": {
"authentication_algorithm": "sha2-256",
"encryption_algorithm": "aes-128",
"pfs": "group15",
"transform_protocol": "esp",
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
"created_at": "2024-06-28T13:59:59.633Z",
"updated_at": "2024-06-28T13:59:59.633Z",
"enterprise_project_id": "0",
"ha_role":"master"
}
],
"page_info": {
"next_marker": "2024-06-28T13:59:59.633Z",
"current_count": 2
},
"request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
"total_count": 12
}</pre>
</li></ol>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001807530300__en-us_topic_0000001594472953_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_0026.html">VPN Connection</a></div>
</div>
</div>
View Git Blame Copy Permalink