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

578 lines
76 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001854089197"></a><a name="EN-US_TOPIC_0000001854089197"></a>
<h1 class="topictitle1">Querying a Specified VPN Connection</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p142661254167">This API is used to query a VPN connection with a specified connection ID.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p141046483329">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_0000001854089197__en-us_topic_0000001594193209_section46808346"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1352174255110">GET /v5/{project_id}/vpn-connection/{vpn_connection_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table3672032" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_p43154149">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row5825185"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row2011282117553"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p172701540610">vpn_connection_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_0000001854089197__en-us_topic_0000001594193209_p6270354061">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_0000001854089197__en-us_topic_0000001594193209_p1027015542613">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_0000001854089197__en-us_topic_0000001594193209_p82710544610">Specifies a VPN connection ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul5992193374713"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li154271011149">Request parameters<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1855835810719"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li154271011149"></a><a name="en-us_topic_0000001594193209_li154271011149"></a>None</p>
</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li18143155715912">Example request<pre class="screen" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_screen1778465375316">GET https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul2144514204819"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li61441714114816">Response parameters<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p13276175413613"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li61441714114816"></a><a name="en-us_topic_0000001594193209_li61441714114816"></a>Returned status code 200: successful operation</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92829" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response body</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row104417415155"><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_0000001854089197__en-us_topic_0000001594193209_p164454151512">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_0000001854089197__en-us_topic_0000001594193209_p1945154201519">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_0000001854089197__en-us_topic_0000001594193209_p1445746158">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row104419461517"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1458461511">vpn_connection</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_0000001854089197__en-us_topic_0000001594193209_p12111852152819"><a href="#EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92830">ResponseVpnConnection</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_0000001854089197__en-us_topic_0000001594193209_p124616461512">Specifies the VPN connection object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row644194131510"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p64644111514">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_0000001854089197__en-us_topic_0000001594193209_p64615411159">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_0000001854089197__en-us_topic_0000001594193209_p154611418155">Specifies a request ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92830"></a><a name="en-us_topic_0000001594193209_table92830"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92830" frame="border" border="1" rules="all"><caption><b>Table 3 </b>ResponseVpnConnection</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row144774101515"><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_0000001854089197__en-us_topic_0000001594193209_p174814101518">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.2%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p44814410153">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.58%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p134818417159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row74719421510"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p18473132910519">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p847317291758">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul1064673414438"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li4646123404312">Specifies a VPN connection ID.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li2044713122414">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row184718411512"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p9473329351">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p147316291953">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul1257530132415"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li984125514435">Specifies a VPN connection name. If no VPN connection name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_row0471343152"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p15013411517">status</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p2505471516">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul119317517446"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li17931115154418">Specifies the status of the VPN connection.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1229019710442">Value range:<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p2179144614349"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1229019710442"></a><a name="en-us_topic_0000001594193209_li1229019710442"></a><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b227215109319">ERROR</strong>: abnormal</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1421515147359"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b187800085305011">ACTIVE</strong>: normal</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p825913614377"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b410563119320">DOWN</strong>: not connected</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p628116353"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b92178119604949">PENDING_CREATE</strong>: creating</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p19268028193515"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b85791346164418">PENDING_UPDATE</strong>: updating</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p15288137143515"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b173412589923851">PENDING_DELETE</strong>: deleting</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p165022046226"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b97851933204618">FREEZED</strong>: frozen</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p6318164063416"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b477754694610">UNKNOWN</strong>: unknown</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row1747194101518"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p124741529454">vgw_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p74741629550">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul897315513244"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li13973154244">Specifies a VPN gateway ID.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li91977350441">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row6471046150"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p14744294518">vgw_ip</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p154741029252">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul19318939192411"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1731873912414">Specifies an EIP ID or private IP address of the VPN gateway.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_row7475413157"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p184745291055">style</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1947402910513">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul97381430161412"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li17381830121413">Specifies the connection mode.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li106691158111412">Value range:<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1597143419533"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li106691158111412"></a><a name="en-us_topic_0000001594193209_li106691158111412"></a><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b46547703365428">POLICY</strong>: policy-based mode</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1497133445316"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b158626032465432">STATIC</strong>: static routing mode</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p19971153485311"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b119910943765436">BGP</strong>: BGP routing mode</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p3849151116117"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b9855182617162">POLICY-TEMPLATE</strong>: policy template mode</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row2479451519"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p194747291656">cgw_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1247432914515">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul18590024121317"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li117211751101313">Specifies a customer gateway ID.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li9590152415133">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row124720419157"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1547542912510">peer_subnets</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p194751429056">Array of String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p72901113144318">Specifies a customer subnet. This parameter is not returned when the association mode of the VPN gateway is <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b1661185118441">ER</strong> and <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b136165112446">style</strong> is <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b66245116441">BGP</strong> or <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b462051184416">POLICY</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row1547443158"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1047512291059">tunnel_local_address</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p447592917513">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_b128844030865622">style</strong> is <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b94834630865622">STATIC</strong> or <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b34800261865622">BGP</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row204715413156"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1347513291555">tunnel_peer_address</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p247518298511">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_b1820215065622">style</strong> is <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b147535609365622">STATIC</strong> or <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b145139671065622">BGP</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row747194101510"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p14475142920511">enable_nqa</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p84757291351">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul5337132316265"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1266518506914">Specifies whether NQA is enabled. This parameter is returned only when <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b188362242597">style</strong> is <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b108363248593">STATIC</strong>.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1665950492">The value can be <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b1585372915591">true</strong> or <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b20854102985914">false</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row114744141516"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1458645150">policy_rules</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p35819421511">Array of <a href="#EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92831">PolicyRule</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1247510294516">Specifies policy rules, which are returned only when <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b510706156111523">style</strong> is set to <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b1215934301111523">POLICY</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row64715441518"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1459124151518">ikepolicy</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1510765064813"><a href="#EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92832">IkePolicy</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p03543072813">Specifies the IKE policy object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row1047342155"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p35910415159">ipsecpolicy</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p01096501487"><a href="#EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92833">IpsecPolicy</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1635230112813">Specifies the IPsec policy object.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row19471147151"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p24754291152">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p4475162914519">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul8192171632415"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li111711019132411">Specifies the time when the VPN connection is created.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li16192416112418">The UTC time format is <em id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_i24988821833934">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row147154171514"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p104761029453">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1947642916520">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul6106151392213"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li61713191247">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_i100628323433934">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row144710417154"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1047613291956">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p04761292053">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul1346517119494"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1243612127408">Specifies an enterprise project ID.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_b103855558295425">vgw_id</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row118305329405"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p3688384332">connection_monitor_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p12688148193319">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul1660883211364"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_li1960815325369">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row73171388462"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1316114817376">ha_role</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p9161048193716">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul516134823715"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li816124833714">For a VPN gateway in active-standby mode, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b169996535553340">master</strong> indicates the active connection, and <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b195473144553340">slave</strong> indicates the standby connection. For a VPN gateway in active-active mode, the value of <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b180117459053419">ha_role</strong> can only be <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b96170245953419">master</strong>.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1516144819375">The default value is <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b134795521552722">master</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row992453474310"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p14785225145413">tags</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p147855259548">Array of <a href="#EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table4138248135518">VpnResourceTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1280042717591">Specifies a tag list.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row162649373525"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p197601059134318">eip_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p20848192034414">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul5536750154420"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li05361450114414">Specifies an EIP ID or private IP address of the VPN gateway.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_p44963582149"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li15536115074411"></a><a name="en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_row282683965213"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p16179152174410">type</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p12179222448">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul106464105013"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li116594175020">Specifies the connection mode.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li196594185014">Value range:<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p96514185013"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li196594185014"></a><a name="en-us_topic_0000001594193209_li196594185014"></a><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b171631847671736">POLICY</strong>: policy-based mode</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p176564125020"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b40758681271751">ROUTE</strong>: routing mode</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_row5291164220523"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p15971555174318">route_mode</p>
</td>
<td class="cellrowborder" valign="top" width="22.2%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p85971554431">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.58%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul6822164365013"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li582204305020">Specifies the routing mode.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li16822114385020">Value range:<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p0822043105010"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li16822114385020"></a><a name="en-us_topic_0000001594193209_li16822114385020"></a><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b126853740371759">static</strong>: static routing mode</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p182284315013"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b15152181014188">bgp</strong>: BGP routing mode</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_table92831"></a><a name="en-us_topic_0000001594193209_table92831"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92831" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PolicyRule</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row19631444152"><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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_p16415417157">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row6631842159"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul31891344132814"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1918954413287">Specifies a rule ID.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li197041251162810">The value ranges from 0 to 50.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row16319431519"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_p1847620291056">Specifies a source CIDR block.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row1263443151"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_table92832"></a><a name="en-us_topic_0000001594193209_table92832"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92832" frame="border" border="1" rules="all"><caption><b>Table 5 </b>IkePolicy</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row167104141515"><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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_p10684420159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row176718412155"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul162887853418"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li11288384341">Specifies the IKE version.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li121218100348">The value can be <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b153496079345319">v1</strong> or <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b13607503145319">v2</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row14672461519"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul1940203911342"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li19414438348">Specifies the negotiation mode. This parameter is available only when the IKE version is <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b4232340627156">v1</strong>.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1840418154818">Value range:<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1622924791"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1840418154818"></a><a name="en-us_topic_0000001594193209_li1840418154818"></a><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b4877207807215">main</strong>: ensures high security during negotiation.</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p13622182412914"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b8084178077219">aggressive</strong>: ensures fast negotiation and a high negotiation success rate.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row467045150"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul17478132133519"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1368346062">Specifies an authentication algorithm.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li84782219355">The value can be <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b13872102733214">sha2-512</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b1287282773216">sha2-384</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b487212713212">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b12872162713216">sha1</strong>, or <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b2872227153212">md5</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row867124201517"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul55059257363"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li350542515364">Specifies an encryption algorithm.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li756133143611">The value can be <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b52791030103211">aes-256-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b1279730143218">aes-128-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b427943017321">aes-256</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b5279163083219">aes-192</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b19279153083215">aes-128</strong>, or <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b1227919302327">3des</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row26717414158"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul551518553814"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li14515165133817">Specifies the DH group used for key exchange in phase 1. </li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li54682070387">The value can be <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b31055415352226">group1</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b128507269452226">group2</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b38253358152226">group5</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b173751579152226">group14</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b162558622652226">group15</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b176664167952226">group16</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b41205158052226">group19</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b209531506552226">group20</strong>, or <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b105835526152226">group21</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row186734121516"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul1581114202398"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li208111720173920">Specifies the authentication method used during IKE negotiation.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li152260571264">Value range:<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p618175810611"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li152260571264"></a><a name="en-us_topic_0000001594193209_li152260571264"></a><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b182224224152331">pre-share</strong>: pre-shared key</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row2671648154"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul1080514275402"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li9805132724020">Specifies the SA lifetime. When the lifetime expires, an IKE SA is automatically updated.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li14636173511403">The value ranges from 60 to 604800, in seconds.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row2067548154"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul1823815102417"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li52381810134118">Specifies the local ID type. </li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li166921028105220">Value range:<ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul219783218523"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li168791526195220">ip</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li72203585219">fqdn (currently not supported)</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row467743153"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_p1182183913526">Specifies the local ID. When <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b81131415180">local_id_type</strong> is set to <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b101131610182">ip</strong>, the VPN gateway IP address corresponding to the VPN connection is returned. When <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b4113131101817">local_id_type</strong> is set to <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b5113619182">fqdn</strong>, the local ID specified during VPN connection creation or update is returned.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row1567041155"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul6534115182915"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li19534195102916">Specifies the peer ID type. </li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1297628185311">Value range:<ul id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_ul4971828155313"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li129710285537">ip</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li797228125318">fqdn (currently not supported)</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row12673461515"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_p17500810193016">Specifies the peer ID. When <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b49041276182">peer_id_type</strong> is set to <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b090412781815">ip</strong>, the IP address of the customer gateway is returned. When <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b149049781810">peer_id_type</strong> is set to <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b1690415761813">fqdn</strong>, the peer ID specified during VPN connection creation or update is returned.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row146764191517"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p1354414416152">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_0000001854089197__en-us_topic_0000001594193209_p8306350184814"><a href="#EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92835">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_0000001854089197__en-us_topic_0000001594193209_p25441143154">Specifies the DPD object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92835"></a><a name="en-us_topic_0000001594193209_table92835"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92835" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Dpd</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row1280174111520"><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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_p85442461513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row128018419150"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul114771912101513"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1947719123158">Specifies the interval for retransmitting DPD packets.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li15477612191517">The value ranges from 2 to 60, in seconds.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row38016414151"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul177072019154313"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li2070751984314">Specifies the DPD idle timeout period.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li19462110431">The value ranges from 10 to 3600, in seconds.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row180134201518"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul158125219446"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li897532204516">Specifies the format of DPD packets.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1284051412717">Value range:<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p114862251076"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1284051412717"></a><a name="en-us_topic_0000001594193209_li1284051412717"></a><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b144787861764515">seq-hash-notify</strong>: indicates that the payload of DPD packets is in the sequence of hash-notify.</p>
<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p99061371978"><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b183975882794737">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_0000001854089197__en-us_topic_0000001594193209_table92833"></a><a name="en-us_topic_0000001594193209_table92833"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table92833" frame="border" border="1" rules="all"><caption><b>Table 7 </b>IpsecPolicy</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row78314181518"><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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_p11546347151">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row483164141515"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul1250214005118"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li7907163744912">Specifies an authentication algorithm.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li109073377499">The value can be <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b37351443153211">sha2-512</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b973544319324">sha2-384</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b147362043143215">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b37361743153216">sha1</strong>, or <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b37361443123215">md5</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row7832441510"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul125025401511"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1608112013145">Specifies an encryption algorithm.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li8416185984916">The value can be <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b187481745123216">aes-256-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b174894511327">aes-128-gcm-16</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b5749164513322">aes-256</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b3749184514324">aes-192</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b3749104512329">aes-128</strong>, or <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b37491457322">3des</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row88315410153"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul1031211105469"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1431281044611">Specifies the DH key group used by PFS. </li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li6312191064619">The value can be <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b156030625464624">group1</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b168175546664624">group2</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b108058284364624">group5</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b33146232964624">group14</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b129273974164624">group15</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b117140061964624">group16</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b118574081664624">group19</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b148104243464624">group20</strong>, <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b201847727564624">group21</strong>, or <strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b75419520664624">disable</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row3831413158"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul13678851104610"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li17678165154616">Specifies the transfer protocol.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1482613195504">Value range:<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p3444122735018"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1482613195504"></a><a name="en-us_topic_0000001594193209_li1482613195504"></a><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b18918504964954">esp</strong>: encapsulating security payload protocol</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row4848416154"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul167218134477"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li15720133479">Specifies the lifetime of a tunnel established over an IPsec connection.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li0903114144715">The value ranges from 30 to 604800, in seconds.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_row3843415156"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul1851117194911"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li4463194741413">Specifies the packet encapsulation mode.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1149413505145">Value range:<p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_p19823165120146"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1149413505145"></a><a name="en-us_topic_0000001594193209_li1149413505145"></a><strong id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_b199504979865148">tunnel</strong>: encapsulates packets in tunnel mode.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table4138248135518"></a><a name="en-us_topic_0000001594193209_table4138248135518"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_table4138248135518" frame="border" border="1" rules="all"><caption><b>Table 8 </b>VpnResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_p913874812558">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul4177729133712"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1217762923713">Specifies a tag key.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_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_0000001854089197__en-us_topic_0000001594193209_ul10177112943717"><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li1917702915375">Specifies a tag value.</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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>
</li><li id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_li8669132111017">Example response<pre class="screen" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_screen678017232489">{
"vpn_connection": {
"id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3",
"name": "vpn-1655",
"status": "DOWN",
"vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d",
"vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde",
"style": "POLICY",
"cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d",
"peer_subnets": ["192.168.0.0/24"],
"tunnel_local_address": "169.254.56.225/30",
"tunnel_peer_address": "169.254.56.226/30",
"policy_rules": [{
"rule_index": 1,
"source": "10.0.0.0/24",
"destination": [
"192.168.0.0/24"
]
}],
"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.***.***.134",
"peer_id_type": "ip",
"peer_id": "88.***.***.164",
"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",
"ha_role":"master"
},
"request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001854089197__en-us_topic_0000001594193209_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