vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpn/api-ref/en_topic_0093011516.html
gtema 6b71b4a1fa Initial import of the VPN API document 
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>
2022-12-07 13:22:09 +00:00

171 lines
16 KiB
HTML
Raw Blame History

<a name="en_topic_0093011516"></a><a name="en_topic_0093011516"></a>
<h1 class="topictitle1">Creating a VPN Endpoint Group</h1>
<div id="body8662426"><div class="section" id="en_topic_0093011516__en-us_topic_0053740037_section57841469"><h4 class="sectiontitle"><strong id="en_topic_0093011516__en-us_topic_0053740037_b842352706112523">Function</strong></h4><p id="en_topic_0093011516__en-us_topic_0053740037_p19009899">This interface is used to create a VPN endpoint group.</p>
</div>
<div class="section" id="en_topic_0093011516__en-us_topic_0053740037_section50811173"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011516__p35111058151818">POST /v2.0/vpn/endpoint-groups</p>
</div>
<div class="section" id="en_topic_0093011516__en-us_topic_0053740037_section22064367"><h4 class="sectiontitle">Request Message</h4><p id="en_topic_0093011516__p1014039171919"><a href="#en_topic_0093011516__en-us_topic_0053740037_table31025868">Table 1</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="en_topic_0093011516__en-us_topic_0053740037_table31025868"></a><a name="en-us_topic_0053740037_table31025868"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011516__en-us_topic_0053740037_table31025868" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="en_topic_0093011516__en-us_topic_0053740037_row17177639"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="en_topic_0093011516__en-us_topic_0053740037_p49211517">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_0093011516__en-us_topic_0053740037_p26709911">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_0093011516__en-us_topic_0053740037_p16019165">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_0093011516__en-us_topic_0053740037_p22484025">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en_topic_0093011516__en-us_topic_0053740037_row9266704"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011516__en-us_topic_0053740037_p12405580">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011516__en-us_topic_0053740037_p65327957">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011516__en-us_topic_0053740037_p57073170">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011516__en-us_topic_0053740037_p59524076">Specifies the endpoint list. The endpoints in a list must be of the same type.</p>
</td>
</tr>
<tr id="en_topic_0093011516__en-us_topic_0053740037_row65954639"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011516__en-us_topic_0053740037_p40725534">type</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011516__en-us_topic_0053740037_p10433982">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011516__en-us_topic_0053740037_p39846231">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011516__en-us_topic_0053740037_p6319248">Specifies the endpoint type. The value can be <strong id="en_topic_0093011516__en-us_topic_0053740037_b126583707521264">subnet</strong> or <strong id="en_topic_0093011516__en-us_topic_0053740037_b191796307321264">cidr</strong>.</p>
</td>
</tr>
<tr id="en_topic_0093011516__en-us_topic_0053740037_row56873232"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011516__en-us_topic_0053740037_p43329052">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011516__en-us_topic_0053740037_p19992349">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011516__en-us_topic_0053740037_p8767611">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011516__en-us_topic_0053740037_p39087901">Specifies the VPN endpoint group name.</p>
</td>
</tr>
<tr id="en_topic_0093011516__en-us_topic_0053740037_row16246796"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011516__en-us_topic_0053740037_p40922063">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011516__en-us_topic_0053740037_p26352844">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011516__en-us_topic_0053740037_p54205609">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011516__en-us_topic_0053740037_p28578190">Specifies the project ID.</p>
</td>
</tr>
<tr id="en_topic_0093011516__en-us_topic_0053740037_row8017921"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011516__en-us_topic_0053740037_p45471841">description</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011516__en-us_topic_0053740037_p59340514">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011516__en-us_topic_0053740037_p41852331">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011516__en-us_topic_0053740037_p34595685">Provides supplementary information about the VPN endpoint group.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="en_topic_0093011516__note1052123018198"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ol id="en_topic_0093011516__ol165221930161910"><li id="en_topic_0093011516__li452212309199">The <strong id="en_topic_0093011516__en-us_topic_0053740027_b84235270620329">project_id</strong> parameter is not supported.</li><li id="en_topic_0093011516__li75221230151916">The value of <strong id="en_topic_0093011516__en-us_topic_0053740037_b120501305120950">tenant_id</strong> can contain a maximum of 255 characters.</li><li id="en_topic_0093011516__li1052218305192">The value of <strong id="en_topic_0093011516__en-us_topic_0053740037_b842352706144933">name</strong> can contain 1 to 64 characters.</li><li id="en_topic_0093011516__li752923011920">The value of <strong id="en_topic_0093011516__en-us_topic_0053740037_b120501305120950_1">description</strong> can contain a maximum of 255 characters.</li><li id="en_topic_0093011516__li15529183019196">The value of <strong id="en_topic_0093011516__en-us_topic_0053740037_b8423527061797">type</strong> can only be <strong id="en_topic_0093011516__en-us_topic_0053740037_b84235270617913">subnet</strong> or <strong id="en_topic_0093011516__en-us_topic_0053740037_b84235270617917">cidr</strong>.</li></ol>
</div></div>
</div>
<div class="section" id="en_topic_0093011516__en-us_topic_0053740037_section64361578"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011516__p116708502015"><a href="#en_topic_0093011516__en-us_topic_0053740037_table50787128">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="en_topic_0093011516__en-us_topic_0053740037_table50787128"></a><a name="en-us_topic_0053740037_table50787128"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011516__en-us_topic_0053740037_table50787128" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="en_topic_0093011516__en-us_topic_0053740037_row43130086"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.4.3.2.5.1.1"><p id="en_topic_0093011516__en-us_topic_0053740037_p3876045">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.3.2.5.1.2"><p id="en_topic_0093011516__en-us_topic_0053740037_p45524249">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.3.2.5.1.3"><p id="en_topic_0093011516__en-us_topic_0053740037_p63585586">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.4.3.2.5.1.4"><p id="en_topic_0093011516__en-us_topic_0053740037_p50158847">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en_topic_0093011516__en-us_topic_0053740037_row36334825"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011516__en-us_topic_0053740037__Hlk477536615">description</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011516__en-us_topic_0053740037_p22104370">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011516__en-us_topic_0053740037_p45623521">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011516__en-us_topic_0053740037_p4517709">Provides supplementary information about the VPN endpoint group.</p>
</td>
</tr>
<tr id="en_topic_0093011516__en-us_topic_0053740037_row40659381"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011516__en-us_topic_0053740037_p5075526">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011516__en-us_topic_0053740037_p8464456">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011516__en-us_topic_0053740037_p14532322">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011516__en-us_topic_0053740037_p36267453">Specifies the project ID.</p>
</td>
</tr>
<tr id="en_topic_0093011516__en-us_topic_0053740037_row57971626"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011516__en-us_topic_0053740037_p65190153">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011516__en-us_topic_0053740037_p45911036">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011516__en-us_topic_0053740037_p27806444">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011516__en-us_topic_0053740037_p37729472">Specifies the endpoint list. The endpoints in a list must be of the same type.</p>
</td>
</tr>
<tr id="en_topic_0093011516__en-us_topic_0053740037_row4020931"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011516__en-us_topic_0053740037_p57260009">type</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011516__en-us_topic_0053740037_p7549159">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011516__en-us_topic_0053740037_p7502182">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011516__en-us_topic_0053740037_p3697038">Specifies the endpoint type. The value can be <strong id="en_topic_0093011516__en-us_topic_0053740037_b126583707521264_1">subnet</strong> or <strong id="en_topic_0093011516__en-us_topic_0053740037_b191796307321264_1">cidr</strong>.</p>
</td>
</tr>
<tr id="en_topic_0093011516__en-us_topic_0053740037_row33273344"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011516__en-us_topic_0053740037_p10786359">id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011516__en-us_topic_0053740037_p1279915">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011516__en-us_topic_0053740037_p36564291">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011516__en-us_topic_0053740037_p8917608">Specifies the VPN endpoint group ID.</p>
</td>
</tr>
<tr id="en_topic_0093011516__en-us_topic_0053740037_row13149610"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011516__en-us_topic_0053740037_p58485517">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011516__en-us_topic_0053740037_p39706416">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011516__en-us_topic_0053740037_p62103099">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011516__en-us_topic_0053740037_p64295127">Specifies the VPN endpoint group name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en_topic_0093011516__en-us_topic_0053740037_section42383293"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011516__ul13354194017208"><li id="en_topic_0093011516__li11354134042019">Example Request<pre class="screen" id="en_topic_0093011516__en-us_topic_0053740037_screen546501417349">POST /v2.0/vpn/endpoint-groups
{
"endpoint_group" : {
"endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],
"type" : "cidr",
"name" : "peers"
}
}</pre>
</li></ul>
</div>
<ul id="en_topic_0093011516__ul10470497202"><li id="en_topic_0093011516__li44714972012">Example Response<pre class="screen" id="en_topic_0093011516__screen1606358102013">{
"endpoint_group" : {
"description" : "",
"tenant_id" : "4ad57e7ce0b24fca8f12b9834d91079d",
"endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],
"type" : "cidr",
"id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
"name" : "peers"
}
}</pre>
</li></ul>
<div class="section" id="en_topic_0093011516__section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011516__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_0093011515.html">VPN Endpoint Group Management</a></div>
</div>
</div>
View Git Blame Copy Permalink