forked from docs/doc-exports
Hongwei, King Wang
32c06a10a2
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>
169 lines
18 KiB
HTML
169 lines
18 KiB
HTML
<a name="EN-US_TOPIC_0000001807530384"></a><a name="EN-US_TOPIC_0000001807530384"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About an IKE Policy</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_section11984159"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p66164776">This API is used to query details about an IKE policy.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_section40748571"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p15941655687">GET /v2.0/vpn/ikepolicies/{ikepolicy_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_table6239218796" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row723918188913"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p10239918692">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_0000001807530384__en-us_topic_0000001591841845_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-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_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-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p22471818494">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row72472185920"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_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-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p525541811914">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_0000001807530384__en-us_topic_0000001591841845_p16255101814915">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_0000001807530384__en-us_topic_0000001591841845_p626314181394">Specifies the IKE policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_section12299945"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p591062344215">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_section43590645"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p17835219141016"><a href="#EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_table20119003">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_table20119003"></a><a name="en-us_topic_0000001591841845_table20119003"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_table20119003" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row28597308"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_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-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_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-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p33757095">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row49970185"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p21053208">ikepolicy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p27588283">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_0000001807530384__en-us_topic_0000001591841845_p14122463">Specifies the IKE policy object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row47637903"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p33464950">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_0000001807530384__en-us_topic_0000001591841845_p26306458">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_0000001807530384__en-us_topic_0000001591841845_p59784887">Provides supplementary information about the IKE policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row1193073"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_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-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p43129175">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_0000001807530384__en-us_topic_0000001591841845_p39547486">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row21477321"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_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-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p51200735">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_0000001807530384__en-us_topic_0000001591841845_p48163256">Specifies the authentication hash algorithm, which can be <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b842352706221137">md5</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b842352706221141">sha1</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b842352706221145">sha2-256</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b842352706221149">sha2-384</strong>, or <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b842352706221154">sha2-512</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row30816121"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p13077833">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_0000001807530384__en-us_topic_0000001591841845_p52671525">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_0000001807530384__en-us_topic_0000001591841845_p34340132">Specifies the IKE policy name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row40625737"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_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-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p56165728">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_0000001807530384__en-us_topic_0000001591841845_p8575450">Specifies the encryption algorithm, which can be <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b7141817191911">3des</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b1714215176194">aes-128</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b14143101791920">aes-192</strong>, or <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b13144141761914">aes-256</strong>. The default algorithm is <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b41443172198">aes-128</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row10070188"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p10378893">pfs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p35383970">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_0000001807530384__en-us_topic_0000001591841845_p6588145672511">Specifies the PFS, which can be <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b179762243194">group1</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b1497732491916">group2</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b12977132471917">group5</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b10978162431917">group14</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b1397919245199">group15</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b6979172418192">group16</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b5980162491911">group19</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b09811624191911">group20</strong>, <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b1698511240194">group21</strong>, or <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b1998872451918">disable</strong>.</p>
|
|
<p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p489023122614">The default PFS is <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b17655202831919">group5</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row20685786"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p64935954">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p25320898">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_0000001807530384__en-us_topic_0000001591841845_p35977388">Specifies the lifetime value of the SA, which is <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b106321834101917">3600</strong> by default. The default unit is <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b1363423431910">seconds</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row55361044"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_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-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p30639779">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_0000001807530384__en-us_topic_0000001591841845_p36543171">Specifies the IKE mode, which is <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b18546144081916">main</strong> by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row60453091"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p64862199">units</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p19346796">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_0000001807530384__en-us_topic_0000001591841845_p31471768">Specifies the lifecycle unit, which is <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b0419204611199">seconds</strong> by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row14810456"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p58796306">lifetime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p64880336">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_0000001807530384__en-us_topic_0000001591841845_p8363642">Specifies the lifetime object of SA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row8163917"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p57297510">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_0000001807530384__en-us_topic_0000001591841845_p10586695">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_0000001807530384__en-us_topic_0000001591841845_p1634435">Specifies the IKE policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_row14709921"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_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-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_p9249362">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_0000001807530384__en-us_topic_0000001591841845_p9370348">Specifies the IKE version, which can be <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b102730587197">v1</strong> or <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b427414584194">v2</strong>. The default value is <strong id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_b491516162203">v1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_section56771492"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_ul11734154941018"><li id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_li13734849191019">Example request<pre class="screen" id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_screen24512769">GET /v2.0/vpn/ikepolicies/{ikepolicy_id}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_ul17156158161010"><li id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_li201561589101">Example response<pre class="screen" id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_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-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001807530384__en-us_topic_0000001591841845_en-us_topic_0053740035_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_1041.html">IKE Policy Management</a></div>
|
|
</div>
|
|
</div>
|
|
|