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

310 lines
32 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001854089257"></a><a name="EN-US_TOPIC_0000001854089257"></a>
<h1 class="topictitle1">Querying IPsec VPN Connections</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_section23308753"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p56688054">This API is used to query IPsec VPN connections.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_ole_link144"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p345045020522">GET /v2.0/vpn/ipsec-site-connections</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_section13538688"><a name="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_section13538688"></a><a name="en-us_topic_0000001541296734_section13538688"></a><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p1284315440533"><a href="#EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_table56415606">Table 1</a> describes the request parameter.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_table56415606"></a><a name="en-us_topic_0000001541296734_table56415606"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_table56415606" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row24881480"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p2134014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p38637452">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p42625947">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p30149715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row26207835"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p42459867">fields</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p16697212">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p10296933">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p28745279">Controls which parameters are returned. If this parameter is not specified, all parameters will be returned.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_section54739329"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p15356181519108"><a href="#EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_table46666290">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_table46666290"></a><a name="en-us_topic_0000001541296734_table46666290"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_table46666290" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row8970000"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p55481367">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p64805763">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p55963561">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row36754611"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p24333505">peer_cidrs</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p24856892">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p11345162825810">Deprecated parameter</p>
<p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p287710269583">Specifies valid CIDR blocks of a tenant.</p>
<p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p31844657">The format is <em id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_i11920756417">&lt;net_address &gt; / &lt; prefix &gt;</em>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row36662351"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p16860416">mtu</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p23516450">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p8152279">Specifies the maximum transmission unit to address fragmentation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row6261652"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p37431827">peer_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p12079142">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p62795050">Specifies the endpoint group ID (tenant CIDR blocks).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row28284541"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p9346499">ikepolicy_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p18868961">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p50514376">Specifies the IKE policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row51976202"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p49322849">dpd</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p35727861">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p18797239">DPD is used to detect whether the peer is alive.</p>
<p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p1439053017135">For details, see <a href="#EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_table544731556">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row60245124"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p48016903">route_mode</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p64163914">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p5536817">Specifies the route advertising mode. The default mode is <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b409160175141644">static</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row49831357"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p9808084">peer_address</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p56257360">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p5792918">Specifies the remote gateway address.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row52136268"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p62288179">peer_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p12177730">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p38543611">Specifies the remote gateway ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row11348180"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p46787348">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p31678816">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p8565311">Specifies the ID of the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row9978940"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p2987824">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p40687155">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p56478093">Provides supplementary information about the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row55687056"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p14357657">vpnservice_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p22119530">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p36875142">Specifies the VPN service ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row63440828"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p38433454">local_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p26102093">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p61122992">Specifies the endpoint group ID (VPC subnets).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row13236018"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p65484519">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p2645837">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p45253450">Specifies the status of the IPsec VPN connection, which can be <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b842352706164927">ACTIVE</strong>, <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b842352706164931">DOWN</strong>, <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b842352706164935">BUILD</strong>, <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b842352706164939">ERROR</strong>, <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b842352706164943">PENDING_CREATE</strong>, <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b842352706164948">PENDING_UPDATE</strong>, or <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b84235270616508">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row4627874"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p39313476">psk</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p30275003">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p59171655">Specifies the pre-shared key.</p>
<p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p163561325183110">The key</p>
<ul id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_ul16491199171414"><li id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_li960712330315">Can contain 6 to 128 characters.</li><li id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_li2880172743116">Can contain only:<ul id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_ul1427714115311"><li id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_li1449149181418">Digits</li><li id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_li11491790147">Uppercase letters</li><li id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_li154913912144">Lowercase letters</li><li id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_li1549119901412">Special characters: ~ ` ! @ # $ % ^ ( ) - _ + = [ ] { } | \ , . / : ;</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row62782852"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p52246286">initiator</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p4090801">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p63310175">Specifies whether this VPN can only respond to connections or both respond to and initiate connections.</p>
<p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p81484473013">The value can be <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b1182352145318">bi-directional</strong> or <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b1182314214535">response-only</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row32920667"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p49328407">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p36177998">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p66906707">Specifies the name of the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row65289456"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p53954550">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p8242429">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p55943724">Specifies the administrative status, which can be <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b8536777393">true</strong> or <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b1053620717391">false</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row33731474"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p47894862">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p54278574">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p42092667">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row43289691"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p16804102">ipsecpolicy_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p18955034">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p11253402">Specifies the IPsec policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row34171757"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p16448913">auth_mode</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p57293570">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p26365928">Specifies the authentication mode. The default mode is <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b574618455449">psk</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row13498121111815"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p10965312685">order_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p189652129811">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p1196516121818">Specifies the ID of a yearly/monthly order.</p>
<p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p15109850164710">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row154999117818"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p496551211810">product_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p696581215815">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p199659121888">Specifies the ID of a product that is billed on a yearly/monthly basis.</p>
<p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p111391352154710">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row449911116819"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p139659124816">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p496581217812">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p17965131214815">Specifies the time when the IPsec connection was created.</p>
<p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p1824182111301">The time is in <em id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_i1146782315531">YYYY-mm-dd HH:MM:SS.ffffff</em> format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row1149951110816"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p159665121081">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p1096619125818">List&lt;Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p696617124813">Specifies the tags.</p>
<ul id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_ul4992117124519"><li id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_li119921117184520">By default, <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b38431754175713">tags</strong> is left blank.</li><li id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_li135166191458">If tags have been created for the VPN connection, <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b197781057155714">tags</strong> is the created tags.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row36714506309"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p26716501300">ipsec_site_connections</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p467195013015">List&lt;Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p1167115013017">Specifies the VPN connection list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_table544731556"></a><a name="en-us_topic_0000001541296734_table544731556"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_table544731556" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b125771061711">dpd</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row14446313551"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p164413135517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p1441536557">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p1644234556">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row1944113145510"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p19141941165713">action</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p1749113119585">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p445051710586">Specifies the DPD action, which can be <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b12304547171">clear</strong>, <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b15305341179">hold</strong>, <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b630617413177">restart</strong>, <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b14307164131713">disabled</strong>, or <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b43106461718">restart-by-peer</strong>. The default action is <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b44071212131715">hold</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row114519317553"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p645113135513">interval</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p1149116185817">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p15648161541019">Specifies the DPD interval in seconds. The default interval is <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b94951323111716">30</strong> seconds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_row311418115574"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p911551118578">timeout</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p13758830294">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_p7802145596">Specifies the DPD timeout. The default timeout is <strong id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_b6671624171713">120</strong> seconds.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_section22891915"><h4 class="sectiontitle">Example request</h4><pre class="screen" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_screen55265455">GET /v2.0/vpn/ipsec-site-connections</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_section4700647"><h4 class="sectiontitle">Example response</h4><pre class="screen" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_screen6468986318425">{
"ipsec_site_connections" : [ {
"status" : "PENDING CREATE",
"psk" : "secret",
"initiator" : "bi-directional",
"name" : "vpnconnection1",
"admin_state_up" : true,
"tenant_id" : "10039663455a446d8ba2cbb058b0f578",
"auth_mode" : "psk",
"peer_cidrs" : [ ],
"mtu" : 1500,
"peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
"ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
"vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
"dpd" : {
"action" : "hold",
"interval" : 30,
"timeout" : 120
},
"route_mode" : "static",
"ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
"local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68",
"peer_address" : "172.24.4.226",
"peer_id" : "172.24.4.226",
"id" : "851f280f-5639-4ea3-81aa-e298525ab74b",
"description" : "",
"order_id": "",
"product_id": "",
"created_at": "2020-08-05 12:39:35.921257",
"tags": []
} ]
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001854089257__en-us_topic_0000001541296734_en-us_topic_0053740035_p19515943486">For details, see <a href="vpn_api_1054.html#EN-US_TOPIC_0000001854089293">Common Returned Values</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_1023.html">IPsec Connection Management</a></div>
</div>
</div>
View Git Blame Copy Permalink