forked from docs/doc-exports
gtema
6b71b4a1fa
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: gtema <artem.goncharov@gmail.com> Co-committed-by: gtema <artem.goncharov@gmail.com>
173 lines
14 KiB
HTML
173 lines
14 KiB
HTML
<a name="en_topic_0093011506"></a><a name="en_topic_0093011506"></a>
|
|
|
|
<h1 class="topictitle1">Querying IPsec Policies</h1>
|
|
<div id="body12001237"><div class="section" id="en_topic_0093011506__section18389930"><h4 class="sectiontitle"><strong id="en_topic_0093011506__b842352706112523">Function</strong></h4><p id="en_topic_0093011506__p32576140">This interface is used to query IPsec policies.</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011506__section31291646"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011506__p1568955175712">GET /v2.0/vpn/ipsecpolicies</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011506__section51595365"><h4 class="sectiontitle">Request Message</h4><p id="en_topic_0093011506__p99531031185819"><a href="#en_topic_0093011506__table47787675">Table 1</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011506__table47787675"></a><a name="table47787675"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011506__table47787675" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="en_topic_0093011506__row19017142"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="en_topic_0093011506__p63993496">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_topic_0093011506__p16090703">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_topic_0093011506__p28278595">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_topic_0093011506__p8864859">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011506__row46964992"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011506__p46067993">fields</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011506__p40519951">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011506__p60890569">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011506__p33189039">Controls which parameters are returned. If this parameter is not specified, all parameters will be returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="en_topic_0093011506__note1021111517586"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en_topic_0093011506__p429171515589">The <strong id="en_topic_0093011506__en-us_topic_0053740027_b84235270620329">project_id</strong> parameter is not supported.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011506__section61705107"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011506__p1898195018584"><a href="#en_topic_0093011506__table3957675">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011506__table3957675"></a><a name="table3957675"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011506__table3957675" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="en_topic_0093011506__row40026340"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="en_topic_0093011506__p20908074">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_topic_0093011506__p15832433">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_topic_0093011506__p59182880">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011506__row29083993"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p6993202">transform_protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p29578451">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p52493967">Specifies the transform protocol used. The value can be <strong id="en_topic_0093011506__b842352706214431">esp</strong>, <strong id="en_topic_0093011506__b842352706214435">ah</strong>, or <strong id="en_topic_0093011506__b842352706214439">ah-esp</strong>. The default value is <strong id="en_topic_0093011506__b842352706185243">esp</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row2683661"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p16049999">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p24981566">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p24211521">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row16577099"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p567760">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p45988614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p9847715">Specifies the IPsec policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row21520579"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p65445301">encapsulation_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p66578044">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p6956456">Specifies the encapsulation mode. The default value is <strong id="en_topic_0093011506__b84235270617116">tunnel</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row62608109"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p38092103">pfs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p65561530">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p6588145672511">Specifies the PFS. The value can be <strong id="en_topic_0093011506__b17777143023410">group1</strong>, <strong id="en_topic_0093011506__b14778113093410">group2</strong>, <strong id="en_topic_0093011506__b877812302349">group5</strong>, <strong id="en_topic_0093011506__b3778143053414">group14</strong>, <strong id="en_topic_0093011506__b37785307341">group15</strong>, <strong id="en_topic_0093011506__b16779630123415">group16</strong>, <strong id="en_topic_0093011506__b6780193053410">group19</strong>, <strong id="en_topic_0093011506__b12780143053418">group20</strong>, <strong id="en_topic_0093011506__b147823300346">group21</strong>, or <strong id="en_topic_0093011506__b147822030143411">disable</strong>.</p>
|
|
<p id="en_topic_0093011506__p489023122614">The default value is <strong id="en_topic_0093011506__b912323216347">group5</strong>.</p>
|
|
<p id="en_topic_0093011506__p2048184412287">The value <strong id="en_topic_0093011506__b29481933163419">disable</strong> indicates that the PFS function is disabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row33761356"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p50315352">lifetime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p49011679">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p47063428">Specifies the lifetime object of SA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row20917673"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p16609919">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p3226198">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p27795493">Specifies the IPsec policy name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row48832851"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p63146847">auth_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p14620943">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p29441404">Specifies the authentication hash algorithm. The value can be <strong id="en_topic_0093011506__b842352706165820">md5</strong>, <strong id="en_topic_0093011506__b842352706165823">sha1</strong>, <strong id="en_topic_0093011506__b842352706165833">sha2-256</strong>, <strong id="en_topic_0093011506__b842352706165840">sha2-384</strong>, or <strong id="en_topic_0093011506__b842352706165851">sha2-512</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row63646052"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p55056607">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p30400195">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p8135907">Provides supplementary information about the IPsec policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row6114302"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p25496434">ipsecpolicies</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p51945267">List<Object></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p34085817">Specifies the IPsec policy list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row66697461"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p33785274">encryption_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p52252659">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p37621475">Specifies the encryption algorithm. The value can be <strong id="en_topic_0093011506__b8423527061721">3des</strong>, <strong id="en_topic_0093011506__b84235270617211">aes-128</strong>, <strong id="en_topic_0093011506__b84235270617219">aes-192</strong>, or <strong id="en_topic_0093011506__b84235270617227">aes-256</strong>. The default value is <strong id="en_topic_0093011506__b84235270617239">aes-128</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row3048957"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p45638969">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p5769005">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p1048160">Specifies the lifetime value of the SA. The default unit is <strong id="en_topic_0093011506__b842352706101036">seconds.</strong> The default value is <strong id="en_topic_0093011506__b842352706101040">3600</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011506__row9433441"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011506__p25911262">units</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011506__p18437496">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011506__p38240801">Specifies the lifecycle unit. The default value is <strong id="en_topic_0093011506__b842352706101045">seconds</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011506__section18475057"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011506__ul1086712045916"><li id="en_topic_0093011506__li186742055912">Example Request<pre class="screen" id="en_topic_0093011506__screen10497152">GET /v2.0/vpn/ipsecpolicies</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en_topic_0093011506__ul087523216593"><li id="en_topic_0093011506__li887512326591">Example Response<pre class="screen" id="en_topic_0093011506__screen863904120595">{
|
|
"ipsecpolicies" : [ {
|
|
"name" : "ipsecpolicy1",
|
|
"transform_protocol" : "esp",
|
|
"auth_algorithm" : "sha1",
|
|
"encapsulation_mode" : "tunnel",
|
|
"encryption_algorithm" : "aes-128",
|
|
"pfs" : "group14",
|
|
"project_id" : "ccb81365fe36411a9011e90491fe1330",
|
|
"tenant_id" : "ccb81365fe36411a9011e90491fe1330",
|
|
"lifetime" : {
|
|
"units" : "seconds",
|
|
"value" : 3600
|
|
},
|
|
"id" : "5291b189-fd84-46e5-84bd-78f40c05d69c",
|
|
"description" : ""
|
|
} ]
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en_topic_0093011506__section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011506__en-us_topic_0053740035_p19515943486">For details, see section <a href="en_topic_0093011522.html">Common Returned Values</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en_topic_0093011503.html">IPsec Policy Management</a></div>
|
|
</div>
|
|
</div>
|
|
|