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>
169 lines
14 KiB
HTML
169 lines
14 KiB
HTML
<a name="en_topic_0093011511"></a><a name="en_topic_0093011511"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About an IKE Policy</h1>
|
|
<div id="body10758903"><div class="section" id="en_topic_0093011511__section11984159"><h4 class="sectiontitle"><strong id="en_topic_0093011511__b842352706112523">Function</strong></h4><p id="en_topic_0093011511__p66164776">This interface is used to query details about an IKE policy.</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011511__section40748571"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011511__p15941655687">GET /v2.0/vpn/ikepolicies/{ikepolicy_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011511__table6239218796" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en_topic_0093011511__row723918188913"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="en_topic_0093011511__p10239918692"><strong id="en_topic_0093011511__b842352706172115">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.2"><p id="en_topic_0093011511__p92472018296">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_topic_0093011511__p192477181092">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_topic_0093011511__p22471818494">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011511__row72472185920"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en_topic_0093011511__p22551718093">ikepolicy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en_topic_0093011511__p525541811914">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en_topic_0093011511__p16255101814915">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en_topic_0093011511__p626314181394">Specifies the IKE policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011511__section12299945"><h4 class="sectiontitle">Request Message</h4><p id="en_topic_0093011511__p591062344215">None</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011511__section43590645"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011511__p17835219141016"><a href="#en_topic_0093011511__table20119003">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011511__table20119003"></a><a name="table20119003"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011511__table20119003" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="en_topic_0093011511__row28597308"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="en_topic_0093011511__p34680572">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_0093011511__p57662920">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_0093011511__p33757095">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011511__row49970185"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p21053208">ikepolicy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011511__p27588283">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p14122463">Specifies the IKE policy object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row47637903"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p33464950">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011511__p26306458">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p59784887">Provides supplementary information about the IKE policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row1193073"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p29530116">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_0093011511__p43129175">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p39547486">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row21477321"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p61941440">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_0093011511__p51200735">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p48163256">Specifies the authentication hash algorithm. The value can be <strong id="en_topic_0093011511__b842352706221137">md5</strong>, <strong id="en_topic_0093011511__b842352706221141">sha1</strong>, <strong id="en_topic_0093011511__b842352706221145">sha2-256</strong>, <strong id="en_topic_0093011511__b842352706221149">sha2-384</strong>, or <strong id="en_topic_0093011511__b842352706221154">sha2-512</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row30816121"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p13077833">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011511__p52671525">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p34340132">Specifies the IKE policy name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row40625737"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p2350413">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_0093011511__p56165728">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p8575450">Specifies the encryption algorithm. The value can be <strong id="en_topic_0093011511__b8423527061721">3des</strong>, <strong id="en_topic_0093011511__b84235270617211">aes-128</strong>, <strong id="en_topic_0093011511__b84235270617219">aes-192</strong>, or <strong id="en_topic_0093011511__b84235270617227">aes-256</strong>. The default value is <strong id="en_topic_0093011511__b84235270617239">aes-128</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row10070188"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p10378893">pfs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011511__p35383970">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p6588145672511">Specifies the PFS. The value can be <strong id="en_topic_0093011511__b5874112573516">group1</strong>, <strong id="en_topic_0093011511__b15874152516358">group2</strong>, <strong id="en_topic_0093011511__b1387592593513">group5</strong>, <strong id="en_topic_0093011511__b178751525163511">group14</strong>, <strong id="en_topic_0093011511__b2087552513357">group15</strong>, <strong id="en_topic_0093011511__b087582519352">group16</strong>, <strong id="en_topic_0093011511__b208761125163510">group19</strong>, <strong id="en_topic_0093011511__b187617255357">group20</strong>, <strong id="en_topic_0093011511__b168781425193516">group21</strong>, or <strong id="en_topic_0093011511__b3878182516358">disable</strong>.</p>
|
|
<p id="en_topic_0093011511__p489023122614">The default value is <strong id="en_topic_0093011511__b17132763517">group5</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row20685786"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p64935954">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011511__p25320898">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p35977388">Specifies the lifetime value of the SA. The default unit is <strong id="en_topic_0093011511__b842352706101552">seconds</strong>. The default value is <strong id="en_topic_0093011511__b842352706101556">3600</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row55361044"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p55059565">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_0093011511__p30639779">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p36543171">Specifies the IKE mode The default value is <strong id="en_topic_0093011511__b842352706213613">main</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row60453091"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p64862199">units</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011511__p19346796">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p31471768">Specifies the lifecycle unit. The default value is <strong id="en_topic_0093011511__b8423527061079">seconds</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row14810456"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p58796306">lifetime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011511__p64880336">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p8363642">Specifies the lifetime object of SA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row8163917"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p57297510">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011511__p10586695">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p1634435">Specifies the IKE policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011511__row14709921"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011511__p50652963">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_0093011511__p9249362">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011511__p18653909">Specifies the IKE version number. The value can be <strong id="en_topic_0093011511__b842352706201636">v1</strong> or <strong id="en_topic_0093011511__b842352706201645">v2</strong>. The default value is <strong id="en_topic_0093011511__b842352706201018">v1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011511__section56771492"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011511__ul11734154941018"><li id="en_topic_0093011511__li13734849191019">Example Request<pre class="screen" id="en_topic_0093011511__screen24512769">GET /v2.0/vpn/ikepolicies/{ikepolicy_id}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en_topic_0093011511__ul17156158161010"><li id="en_topic_0093011511__li201561589101">Example Response<pre class="screen" id="en_topic_0093011511__screen838216781112">{
|
|
"ikepolicy" : {
|
|
"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_0093011511__section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011511__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>
|
|
|