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

311 lines
32 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001854169209"></a><a name="EN-US_TOPIC_0000001854169209"></a>
<h1 class="topictitle1">Querying Details About an IPsec VPN Connection</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_section62260885"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p3531486">This API is used to query details about an IPsec VPN connection.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_section23477058"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p11525122018137">GET /v2.0/vpn/ipsec-site-connections/{connection_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_table975465201311" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row576295251316"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p9762252151315">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p14769952101319">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p17769152151313">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p14769852121311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row1176955271315"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p77775524139">connection_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p1277795291312">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p87779521134">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p277775214138">Specifies the ID of the IPsec VPN connection.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_section22593558"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p6133102333610">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_section2015430"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p19892624171512"><a href="#EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_table21749220">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_table21749220"></a><a name="en-us_topic_0000001591896529_table21749220"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_table21749220" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row63149496"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p14835533">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_0000001854169209__en-us_topic_0000001591896529_p60827539">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_0000001854169209__en-us_topic_0000001591896529_p60181840">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row42890904"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p51611184">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_0000001854169209__en-us_topic_0000001591896529_p19756352">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_0000001854169209__en-us_topic_0000001591896529_p34213098">Specifies the endpoint group ID (VPC subnets).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row39482434"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p43960571">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_0000001854169209__en-us_topic_0000001591896529_p4036497">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_0000001854169209__en-us_topic_0000001591896529_p42565233">Specifies the status of the IPsec VPN connection, which can be <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b842352706164927">ACTIVE</strong>, <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b842352706164931">DOWN</strong>, <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b842352706164935">BUILD</strong>, <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b842352706164939">ERROR</strong>, <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b842352706164943">PENDING_CREATE</strong>, <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b842352706164948">PENDING_UPDATE</strong>, or <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b84235270616508">PENDING_DELETE</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row47542785"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p25760373">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_0000001854169209__en-us_topic_0000001591896529_p6215498">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_0000001854169209__en-us_topic_0000001591896529_p44806966">Specifies the pre-shared key.</p>
<p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p163561325183110">The key</p>
<ul id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_ul16491199171414"><li id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_li960712330315">Can contain 6 to 128 characters.</li><li id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_li2880172743116">Can contain only:<ul id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_ul1427714115311"><li id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_li1449149181418">Digits</li><li id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_li11491790147">Uppercase letters</li><li id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_li154913912144">Lowercase letters</li><li id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_li1549119901412">Special characters: ~ ` ! @ # $ % ^ ( ) - _ + = [ ] { } | \ , . / : ;</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row609510"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p49370368">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_0000001854169209__en-us_topic_0000001591896529_p39576862">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_0000001854169209__en-us_topic_0000001591896529_p19600264">Specifies whether this VPN can only respond to connections or both respond to and initiate connections.</p>
<p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p91591327102912">The value can be <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b1423781211539">bi-directional</strong> or <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b92381412185310">response-only</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row42184651"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p61513540">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_0000001854169209__en-us_topic_0000001591896529_p16540805">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_0000001854169209__en-us_topic_0000001591896529_p9191297">Specifies the name of the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row15612815"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p56678513">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_0000001854169209__en-us_topic_0000001591896529_p27556864">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_0000001854169209__en-us_topic_0000001591896529_p9307971">Specifies the administrative status, which can be <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b842352706221557">true</strong> or <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b84235270622160">false</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row16662877"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p7515778">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_0000001854169209__en-us_topic_0000001591896529_p4798296">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_0000001854169209__en-us_topic_0000001591896529_p7566645">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row990949"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p13158007">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_0000001854169209__en-us_topic_0000001591896529_p59165662">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_0000001854169209__en-us_topic_0000001591896529_p28244554">Specifies the IPsec policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row52874399"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p54967961">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_0000001854169209__en-us_topic_0000001591896529_p23219884">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_0000001854169209__en-us_topic_0000001591896529_p8539194">Specifies the authentication mode. The default mode is <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b12224835144020">psk</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row9743886"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p51057338">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_0000001854169209__en-us_topic_0000001591896529_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_0000001854169209__en-us_topic_0000001591896529_p11345162825810">Deprecated parameter</p>
<p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p287710269583">Specifies valid CIDR blocks of a tenant.</p>
<p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p31844657">The format is <em id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_i121722663915">&lt;net_address &gt; / &lt; prefix &gt;</em>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row66008059"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p45052529">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_0000001854169209__en-us_topic_0000001591896529_p25376232">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_0000001854169209__en-us_topic_0000001591896529_p63478007">Specifies the maximum transmission unit to address fragmentation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row34431157"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p37460321">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_0000001854169209__en-us_topic_0000001591896529_p14387121">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_0000001854169209__en-us_topic_0000001591896529_p38839134">Specifies the IKE policy ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row14007894"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p60897649">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_0000001854169209__en-us_topic_0000001591896529_p33762549">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_0000001854169209__en-us_topic_0000001591896529_p56833109">Specifies the remote gateway address.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row41735936"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p25167636">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_0000001854169209__en-us_topic_0000001591896529_p25312629">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_0000001854169209__en-us_topic_0000001591896529_p48829755">Specifies the ID of the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row36814618"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p29194114">ipsec_site_connection</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p15913018">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_0000001854169209__en-us_topic_0000001591896529_p51028923">Specifies the object of the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row56607127"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p21774588">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_0000001854169209__en-us_topic_0000001591896529_p18911189">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_0000001854169209__en-us_topic_0000001591896529_p59133445">Specifies the route advertising mode. The default mode is <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b934497164112">static</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row62438959"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p24390923">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_0000001854169209__en-us_topic_0000001591896529_p29507743">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_0000001854169209__en-us_topic_0000001591896529_p58343698">Specifies the remote gateway ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row55331235"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p52645056">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_0000001854169209__en-us_topic_0000001591896529_p36391162">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_0000001854169209__en-us_topic_0000001591896529_p56187107">Provides supplementary information about the IPsec VPN connection.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row39254219"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p25475209">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_0000001854169209__en-us_topic_0000001591896529_p50226059">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_0000001854169209__en-us_topic_0000001591896529_p28655997">Specifies the endpoint group ID (tenant CIDR blocks).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row56577386"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p19365543">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_0000001854169209__en-us_topic_0000001591896529_p25105132">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_0000001854169209__en-us_topic_0000001591896529_p18797239">DPD is used to detect whether the peer is alive.</p>
<p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p1439053017135">For details, see <a href="#EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_table544731556">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row41760071"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p27122565">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_0000001854169209__en-us_topic_0000001591896529_p49444123">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_0000001854169209__en-us_topic_0000001591896529_p65754481">Specifies the VPN service ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row182092510510"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p115374261451">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_0000001854169209__en-us_topic_0000001591896529_p75371526556">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_0000001854169209__en-us_topic_0000001591896529_p1953772610516">Specifies the ID of a yearly/monthly order.</p>
<p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p15315144364415">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row82062514514"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p553732610512">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_0000001854169209__en-us_topic_0000001591896529_p175373261952">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_0000001854169209__en-us_topic_0000001591896529_p153713265513">Specifies the ID of a product that is billed on a yearly/monthly basis.</p>
<p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p440818516445">This parameter is only available to yearly/monthly VPNs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row14205256518"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p105372266516">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_0000001854169209__en-us_topic_0000001591896529_p153717261258">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_0000001854169209__en-us_topic_0000001591896529_p1753782620511">Specifies the time when the IPsec connection was created.</p>
<p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p116621053122917">The time is in <em id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_i154165845211">YYYY-mm-dd HH:MM:SS.ffffff</em> format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row10203251751"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_p1653713262512">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_0000001854169209__en-us_topic_0000001591896529_p125377261355">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_0000001854169209__en-us_topic_0000001591896529_p1953820261858">Specifies the tags.</p>
<ul id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_ul4992117124519"><li id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_li119921117184520">By default, <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b1722445155516">tags</strong> is left blank.</li><li id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_li135166191458">If tags have been created for the VPN connection, <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b16929129145614">tags</strong> is the created tags.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_table544731556"></a><a name="en-us_topic_0000001591896529_table544731556"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_table544731556" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b1966563316168">dpd</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_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_0000001854169209__en-us_topic_0000001591896529_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_0000001854169209__en-us_topic_0000001591896529_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_0000001854169209__en-us_topic_0000001591896529_p1644234556">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row1944113145510"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_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_0000001854169209__en-us_topic_0000001591896529_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_0000001854169209__en-us_topic_0000001591896529_p445051710586">Specifies the DPD action, which can be <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b754916370168">clear</strong>, <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b85511737171617">hold</strong>, <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b11552133720165">restart</strong>, <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b8552337151616">disabled</strong>, or <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b145531337181613">restart-by-peer</strong>. The default action is <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b493084310167">hold</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row114519317553"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_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_0000001854169209__en-us_topic_0000001591896529_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_0000001854169209__en-us_topic_0000001591896529_p15648161541019">Specifies the DPD interval in seconds. The default interval is <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b820584512167">30</strong> seconds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_row311418115574"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_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_0000001854169209__en-us_topic_0000001591896529_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_0000001854169209__en-us_topic_0000001591896529_p7802145596">Specifies the DPD timeout. The default timeout is <strong id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_b1834754611165">120</strong> seconds.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_section18138873"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_ul0423119192912"><li id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_li144231913298">Example request<pre class="screen" id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_screen24512769">GET /v2.0/vpn/ipsec-site-connections/{connection_id}</pre>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_ul936871818292"><li id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_li1736820181292">Example response<pre class="screen" id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_screen12438172982910">{
"ipsec_site_connection" : {
"status" : "DOWN",
"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>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_section26431778"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001854169209__en-us_topic_0000001591896529_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