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>
180 lines
14 KiB
HTML
180 lines
14 KiB
HTML
<a name="en_topic_0093011500"></a><a name="en_topic_0093011500"></a>
|
|
|
|
<h1 class="topictitle1">Querying VPN Services</h1>
|
|
<div id="body1166200"><div class="section" id="en_topic_0093011500__section43036322"><h4 class="sectiontitle"><strong id="en_topic_0093011500__b842352706112523">Function</strong></h4><p id="en_topic_0093011500__p27353390">This interface is used to query VPN services.</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011500__ole_link150"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011500__p29283218439">GET /v2.0/vpn/vpnservices</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011500__section33639718"><h4 class="sectiontitle">Request Message</h4><p id="en_topic_0093011500__p12253110446"><a href="#en_topic_0093011500__table57678784">Table 1</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011500__table57678784"></a><a name="table57678784"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011500__table57678784" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="en_topic_0093011500__row24197721"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="en_topic_0093011500__p13858403">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_0093011500__p48788849">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_0093011500__p59582700">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_0093011500__p61469371">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011500__row12963143"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en_topic_0093011500__p43381623">fields</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en_topic_0093011500__p24250547">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en_topic_0093011500__p18137316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en_topic_0093011500__p59836530">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_0093011500__note15811145184312"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en_topic_0093011500__p9593164618433">The <strong id="en_topic_0093011500__en-us_topic_0053740027_b84235270620329">project_id</strong> parameter is not supported.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011500__section34322009"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011500__p1949133310446"><a href="#en_topic_0093011500__table14920772">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011500__table14920772"></a><a name="table14920772"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011500__table14920772" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="en_topic_0093011500__row14434584"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.4.3.2.5.1.1"><p id="en_topic_0093011500__p28350637">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_0093011500__p14700275">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_0093011500__p49871633">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_0093011500__p13070512">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011500__row52078584"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011500__p57615760">vpnservices</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011500__p36364960">List<Object></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011500__p59880657">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011500__p18495050">Specifies the VPN service object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011500__row32237730"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011500__p61119323">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011500__p51718129">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011500__p28418891">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011500__p20228817">Specifies whether the VPN service is currently operational. The value can be <strong id="en_topic_0093011500__b842352706212822">ACTIVE</strong>, <strong id="en_topic_0093011500__b842352706212827">DOWN</strong>, <strong id="en_topic_0093011500__b842352706212832">BUILD</strong>, <strong id="en_topic_0093011500__b842352706212835">ERROR</strong>, <strong id="en_topic_0093011500__b842352706212840">PENDING_CREATE</strong>, <strong id="en_topic_0093011500__b842352706212845">PENDING_UPDATE</strong>, or <strong id="en_topic_0093011500__b842352706212850">PENDING_DELETE</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011500__row47841633"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011500__p49967061">router_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011500__p20800170">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011500__p7092232">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011500__p37599894">Specifies the router ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011500__row2854726"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011500__p29906272">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011500__p6488958">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011500__p55843593">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011500__p27037160">Specifies the VPN service name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011500__row42007851"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011500__p47192740">external_v6_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011500__p64515557">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011500__p58377623">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011500__p30967009">Specifies the IPv6 address of the VPN service external gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011500__row10267631"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011500__p26371793">admin_state_up</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011500__p55740512">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011500__p18687619">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011500__p37302179">Specifies the administrative status. The value can be <strong id="en_topic_0093011500__b842352706221557">true</strong> or <strong id="en_topic_0093011500__b84235270622160">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011500__row175293"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011500__p14198754">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011500__p9248440">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011500__p10926182">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011500__p12605589">Specifies the subnet ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011500__row46341445"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011500__p62669527">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_0093011500__p43066942">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011500__p65870306">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011500__p33894570">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011500__row36615679"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011500__p13080057">external_v4_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011500__p52851724">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011500__p53131231">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011500__p8662426">Specifies the IPv4 address of the VPN service external gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011500__row10852974"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011500__p6675738">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011500__p3863873">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011500__p44538317">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011500__p50833958">Specifies the VPN service ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011500__row54852443"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011500__p13862865">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011500__p49150280">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011500__p21749735">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011500__p16898135">Provides supplementary information about the VPN service.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011500__section40462633"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011500__ul2018313104513"><li id="en_topic_0093011500__li3183014456">Request Example</li></ul>
|
|
<pre class="screen" id="en_topic_0093011500__screen10956331">GET /v2.0/vpn/vpnservices</pre>
|
|
</div>
|
|
<ul id="en_topic_0093011500__ul474101064517"><li id="en_topic_0093011500__li47401074520">Example Response<pre class="screen" id="en_topic_0093011500__screen12511921134515">{
|
|
"vpnservices": [
|
|
{
|
|
"router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa",
|
|
"status": "PENDING_CREATE",
|
|
"name": "myservice",
|
|
"external_v6_ip": "2001:db8::1",
|
|
"admin_state_up": true,
|
|
"subnet_id": null,
|
|
"project_id": "10039663455a446d8ba2cbb058b0f578",
|
|
"tenant_id": "10039663455a446d8ba2cbb058b0f578",
|
|
"external_v4_ip": "172.32.1.11",
|
|
"id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
|
|
"description": "",
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en_topic_0093011500__section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011500__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_0093011497.html">VPN Service Management</a></div>
|
|
</div>
|
|
</div>
|
|
|