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>
171 lines
14 KiB
HTML
171 lines
14 KiB
HTML
<a name="en_topic_0093011512"></a><a name="en_topic_0093011512"></a>
|
|
|
|
<h1 class="topictitle1">Querying IKE Policies</h1>
|
|
<div id="body43216271"><div class="section" id="en_topic_0093011512__section53330552"><h4 class="sectiontitle"><strong id="en_topic_0093011512__b842352706112523">Function</strong></h4><p id="en_topic_0093011512__p10857028">This interface is used to query IKE policies.</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011512__section10212927"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011512__p318012916111">GET /v2.0/vpn/ikepolicies</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011512__section21940722"><h4 class="sectiontitle">Request Message</h4><p id="en_topic_0093011512__p12993171518124"><a href="#en_topic_0093011512__table61502840">Table 1</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011512__table61502840"></a><a name="table61502840"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011512__table61502840" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="en_topic_0093011512__row45420240"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="en_topic_0093011512__p55160823">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_0093011512__p38841670">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_0093011512__p59167590">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_0093011512__p27845503">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011512__row40893240"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011512__p24018105">fields</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011512__p66418347">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011512__p11177013">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011512__p32922880">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_0093011512__note753316579119"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en_topic_0093011512__p14533457151111">The <strong id="en_topic_0093011512__en-us_topic_0053740027_b84235270620329">project_id</strong> parameter is not supported.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011512__section63248778"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011512__p171553218125"><a href="#en_topic_0093011512__table49507636">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011512__table49507636"></a><a name="table49507636"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011512__table49507636" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="en_topic_0093011512__row63187419"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="en_topic_0093011512__p17907308">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_0093011512__p41205809">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_0093011512__p36810105">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011512__row28828491"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p53406450">ikepolicies</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011512__p30955222">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_0093011512__p25792371">Specifies the IKE policy list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row30804749"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p12156768">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011512__p45174131">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p34731002">Provides supplementary information about the IKE policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row44143566"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p18859061">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_0093011512__p51188993">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p38233575">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row4485813"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p27806533">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_0093011512__p37736673">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p25717600">Specifies the authentication hash algorithm. The value can be <strong id="en_topic_0093011512__b842352706221137">md5</strong>, <strong id="en_topic_0093011512__b842352706221141">sha1</strong>, <strong id="en_topic_0093011512__b842352706221145">sha2-256</strong>, <strong id="en_topic_0093011512__b842352706221149">sha2-384</strong>, or <strong id="en_topic_0093011512__b842352706221154">sha2-512</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row30131813"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p24757801">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011512__p59224828">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p13780214">Specifies the IKE policy name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row56913064"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p46555465">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_0093011512__p12896286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p55365254">Specifies the encryption algorithm. The value can be <strong id="en_topic_0093011512__b8423527061721">3des</strong>, <strong id="en_topic_0093011512__b84235270617211">aes-128</strong>, <strong id="en_topic_0093011512__b84235270617219">aes-192</strong>, or <strong id="en_topic_0093011512__b84235270617227">aes-256</strong>. The default value is <strong id="en_topic_0093011512__b84235270617239">aes-128</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row28525238"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p28842926">pfs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011512__p54575646">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p6588145672511">Specifies the PFS. The value can be <strong id="en_topic_0093011512__b698675117355">group1</strong>, <strong id="en_topic_0093011512__b49863518352">group2</strong>, <strong id="en_topic_0093011512__b1987115183511">group5</strong>, <strong id="en_topic_0093011512__b0987105103517">group14</strong>, <strong id="en_topic_0093011512__b299085111351">group15</strong>, <strong id="en_topic_0093011512__b169918510359">group16</strong>, <strong id="en_topic_0093011512__b699145103514">group19</strong>, <strong id="en_topic_0093011512__b179921517359">group20</strong>, <strong id="en_topic_0093011512__b12992135113511">group21</strong>, or <strong id="en_topic_0093011512__b699311511358">disable</strong>.</p>
|
|
<p id="en_topic_0093011512__p489023122614">The default value is <strong id="en_topic_0093011512__b772618554356">group5</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row2598608"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p9160681">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011512__p3817695">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p16291455">Specifies the lifetime value of the SA. The default unit is <strong id="en_topic_0093011512__b842352706101627">seconds</strong>. The default value is <strong id="en_topic_0093011512__b842352706101631">3600</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row12405375"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p65311315">phase1_negotiation_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011512__p55725192">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p3898676">Specifies the IKE mode The default value is <strong id="en_topic_0093011512__b842352706213613">main</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row35088084"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p23562574">units</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011512__p29520332">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p6720246">Specifies the lifecycle unit. The default value is <strong id="en_topic_0093011512__b8423527061079">seconds</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row60482217"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p112514">lifetime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011512__p9113635">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p564191">Specifies the lifetime object of SA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row5077725"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p8642591">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011512__p28961294">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p29858833">Specifies the IKE policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011512__row294043"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011512__p23817504">ike_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011512__p50169686">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011512__p61444595">Specifies the IKE version. The value can be <strong id="en_topic_0093011512__b2123880768213834">v1</strong> or <strong id="en_topic_0093011512__b499525058213834">v2</strong>. The default value is <strong id="en_topic_0093011512__b842352706213844">v1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011512__section32368095"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011512__ul14398212201316"><li id="en_topic_0093011512__li10398312121313">Example Request<pre class="screen" id="en_topic_0093011512__screen10956331">GET /v2.0/vpn/ikepolicies</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en_topic_0093011512__ul17246622151319"><li id="en_topic_0093011512__li9246622121313">Example Response<pre class="screen" id="en_topic_0093011512__screen16213133211132">{
|
|
"ikepolicies" : [ {
|
|
"name" : "ikepolicy1",
|
|
"tenant_id" : "ccb81365fe36411a9011e90491fe1330",
|
|
"auth_algorithm" : "sha1",
|
|
"encryption_algorithm" : "aes-256",
|
|
"pfs" : "group5",
|
|
"phase1_negotiation_mode" : "main",
|
|
"lifetime" : {
|
|
"units" : "seconds",
|
|
"value" : 3600
|
|
},
|
|
"ike_version" : "v1",
|
|
"id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db",
|
|
"description" : ""
|
|
} ]
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en_topic_0093011512__section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011512__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_0093011509.html">IKE Policy Management</a></div>
|
|
</div>
|
|
</div>
|
|
|