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_0093011505"></a><a name="en_topic_0093011505"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About an IPsec Policy</h1>
|
|
<div id="body33559471"><div class="section" id="en_topic_0093011505__section46564252"><h4 class="sectiontitle"><strong id="en_topic_0093011505__b842352706112523">Function</strong></h4><p id="en_topic_0093011505__p33962670">This interface is used to query details about an IPsec policy.</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011505__section16425092"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011505__p1192610719559">GET /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011505__table1825652715511" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en_topic_0093011505__row12264132715556"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="en_topic_0093011505__p102643279555"><strong id="en_topic_0093011505__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_0093011505__p82641027125511">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_0093011505__p1927219279559">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_0093011505__p427219276555">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011505__row132721527165517"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en_topic_0093011505__p1627212278556">ipsecpolicy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en_topic_0093011505__p10272827185512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en_topic_0093011505__p13280427125520">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en_topic_0093011505__p32801027195514">Specifies the IPsec policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="en_topic_0093011505__note11653161210565"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ol id="en_topic_0093011505__ol19246413155615"><li id="en_topic_0093011505__li19246913195620">The <strong id="en_topic_0093011505__en-us_topic_0053740027_b84235270620329">project_id</strong> parameter is not supported.</li><li id="en_topic_0093011505__li824621312569">The <strong id="en_topic_0093011505__b84235270692755">ipsecpolicy_id</strong> parameter must be specified.</li></ol>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011505__section55364084"><h4 class="sectiontitle">Request Message</h4><p id="en_topic_0093011505__p813244115286">None</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011505__section28514710"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011505__p411334220562"><a href="#en_topic_0093011505__table38520254">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011505__table38520254"></a><a name="table38520254"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011505__table38520254" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="en_topic_0093011505__row37494699"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="en_topic_0093011505__p17171756">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_0093011505__p48735027">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_0093011505__p43884268">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011505__row64964848"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p27661336">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011505__p25975757">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p37538044">Specifies the IPsec policy name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row2298077"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p51926520">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_0093011505__p45298596">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p46041549">Specifies the encapsulation mode. The default value is <strong id="en_topic_0093011505__b84235270617116">tunnel</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row11720763"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p9857780">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_0093011505__p60282721">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p42401657">Specifies the encryption algorithm. The value can be <strong id="en_topic_0093011505__b8423527061721">3des</strong>, <strong id="en_topic_0093011505__b84235270617211">aes-128</strong>, <strong id="en_topic_0093011505__b84235270617219">aes-192</strong>, or <strong id="en_topic_0093011505__b84235270617227">aes-256</strong>. The default value is <strong id="en_topic_0093011505__b84235270617239">aes-128</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row46070597"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p40730901">pfs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011505__p10868702">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p6588145672511">Specifies the PFS. The value can be <strong id="en_topic_0093011505__b16631131916346">group1</strong>, <strong id="en_topic_0093011505__b15631121920344">group2</strong>, <strong id="en_topic_0093011505__b563214194344">group5</strong>, <strong id="en_topic_0093011505__b3632519183410">group14</strong>, <strong id="en_topic_0093011505__b16634101920341">group15</strong>, <strong id="en_topic_0093011505__b116342019123412">group16</strong>, <strong id="en_topic_0093011505__b18635111919344">group19</strong>, <strong id="en_topic_0093011505__b3635171993410">group20</strong>, <strong id="en_topic_0093011505__b156351319193417">group21</strong>, or <strong id="en_topic_0093011505__b86354194344">disable</strong>.</p>
|
|
<p id="en_topic_0093011505__p489023122614">The default value is <strong id="en_topic_0093011505__b149071202348">group5</strong>.</p>
|
|
<p id="en_topic_0093011505__p1525913569288">The value <strong id="en_topic_0093011505__b17842102193418">disable</strong> indicates that the PFS function is disabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row23924539"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p58839532">lifetime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011505__p121151126299">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p29516363">Specifies the lifetime object of SA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row64320678"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p42592467">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_0093011505__p27437792">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p33381819">Specifies the transform protocol used. The value can be <strong id="en_topic_0093011505__b842352706184452">esp</strong>, <strong id="en_topic_0093011505__b842352706184456">ah</strong>, or <strong id="en_topic_0093011505__b84235270618456">ah-esp</strong>. The default value is <strong id="en_topic_0093011505__b842352706201018">esp</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row32000920"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p41937705">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_0093011505__p41510976">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p25743641">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row30366184"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p43741849">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011505__p53428882">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p37304191">Specifies the IPsec policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row193401"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p15665491">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_0093011505__p60945241">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p27120652">Specifies the authentication hash algorithm. The value can be <strong id="en_topic_0093011505__b842352706165820">md5</strong>, <strong id="en_topic_0093011505__b842352706165823">sha1</strong>, <strong id="en_topic_0093011505__b842352706165833">sha2-256</strong>, <strong id="en_topic_0093011505__b842352706165840">sha2-384</strong>, or <strong id="en_topic_0093011505__b842352706165851">sha2-512</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row42759282"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p40949840">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011505__p28602718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p26049579">Provides supplementary information about the IPsec policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row57582125"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p33640543">ipsecpolicy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011505__p40529449">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p28400552">Specifies the IPsec policy object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row56982912"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p52213166">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011505__p1408093">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p44589661">Specifies the lifetime value of the SA. The default unit is <strong id="en_topic_0093011505__b84235270610926">seconds</strong>. The default value is <strong id="en_topic_0093011505__b84235270610932">3600</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011505__row65762630"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011505__p25172842">units</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011505__p25734322">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011505__p64098000">Specifies the lifecycle unit. The default value is <strong id="en_topic_0093011505__b84235270610104">seconds</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011505__section55305800"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011505__ul18648141345718"><li id="en_topic_0093011505__li2648713115713">Example Request<pre class="screen" id="en_topic_0093011505__screen24555510">GET /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en_topic_0093011505__ul145345247571"><li id="en_topic_0093011505__li5534192419575">Example Response<pre class="screen" id="en_topic_0093011505__screen174710338577">{
|
|
"ipsecpolicy" : {
|
|
"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_0093011505__section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011505__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>
|
|
|