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>
176 lines
13 KiB
HTML
176 lines
13 KiB
HTML
<a name="en_topic_0093011499"></a><a name="en_topic_0093011499"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About a VPN Service</h1>
|
|
<div id="body46488363"><div class="section" id="en_topic_0093011499__section28631516"><h4 class="sectiontitle"><strong id="en_topic_0093011499__b842352706112523">Function</strong></h4><p id="en_topic_0093011499__p7461047">This interface is used to query details about a VPN service.</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011499__section56357057"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011499__p1613472573211">GET /v2.0/vpn/vpnservices/{service_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011499__table184162115335" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en_topic_0093011499__row984914219336"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="en_topic_0093011499__p8849921163313"><strong id="en_topic_0093011499__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_0093011499__p384918214339">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_0093011499__p208493212330">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_0093011499__p1185732118339">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011499__row10857162110332"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en_topic_0093011499__p17857142117336">service_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en_topic_0093011499__p18857152173311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en_topic_0093011499__p385772133310">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en_topic_0093011499__p28642214334">Specifies the VPN service ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011499__section1518871"><h4 class="sectiontitle">Request Message</h4><p id="en_topic_0093011499__p265563912914">None</p>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011499__section13669843"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011499__p613214493412"><a href="#en_topic_0093011499__table6499254">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en_topic_0093011499__table6499254"></a><a name="table6499254"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011499__table6499254" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="en_topic_0093011499__row35632194"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.4.3.2.5.1.1"><p id="en_topic_0093011499__p526619">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_0093011499__p42656148">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_0093011499__p32595925">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_0093011499__p23024263">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en_topic_0093011499__row53026001"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011499__p138844">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011499__p11246416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011499__p38544467">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011499__p35094160">Specifies whether the VPN service is currently operational. The value can be <strong id="en_topic_0093011499__b842352706212822">ACTIVE</strong>, <strong id="en_topic_0093011499__b842352706212827">DOWN</strong>, <strong id="en_topic_0093011499__b842352706212832">BUILD</strong>, <strong id="en_topic_0093011499__b842352706212835">ERROR</strong>, <strong id="en_topic_0093011499__b842352706212840">PENDING_CREATE</strong>, <strong id="en_topic_0093011499__b842352706212845">PENDING_UPDATE</strong>, or <strong id="en_topic_0093011499__b842352706212850">PENDING_DELETE</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011499__row47411987"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011499__p15165719">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_0093011499__p20463720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011499__p46948589">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011499__p44739342">Specifies the router ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011499__row901"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011499__p73053">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011499__p5917317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011499__p9540645">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011499__p34594790">Specifies the VPN service name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011499__row42917658"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011499__p53778287">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_0093011499__p61073976">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011499__p48045022">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011499__p66441544">Specifies the IPv6 address of the VPN service external gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011499__row61102986"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011499__p50394838">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_0093011499__p55450074">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011499__p62271039">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011499__p10789421">Specifies the administrative status. The value can be <strong id="en_topic_0093011499__b842352706221557">true</strong> or <strong id="en_topic_0093011499__b84235270622160">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011499__row29995926"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011499__p13750947">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_0093011499__p40084941">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011499__p25654779">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011499__p64771222">Specifies the subnet ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011499__row46070087"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011499__p40689584">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_0093011499__p7521977">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011499__p5300362">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011499__p26676172">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011499__row38758958"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011499__p52467932">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_0093011499__p22044110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011499__p40742509">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011499__p11808928">Specifies the IPv4 address of the VPN service external gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011499__row39171493"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011499__p18774354">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011499__p44327687">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011499__p33772909">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011499__p51251115">Specifies the VPN service ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011499__row58606859"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011499__p49535170">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011499__p52925796">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011499__p59131099">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011499__p24889743">Provides supplementary information about the VPN service.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en_topic_0093011499__row22681099"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.4.3.2.5.1.1 "><p id="en_topic_0093011499__p25229732">vpnservice</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.2 "><p id="en_topic_0093011499__p30342446">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.3.2.5.1.3 "><p id="en_topic_0093011499__p41819089">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.4.3.2.5.1.4 "><p id="en_topic_0093011499__p31903028">Specifies the VPN service object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en_topic_0093011499__section55919726"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011499__ul209182312345"><li id="en_topic_0093011499__li12918193117345">Example Request<pre class="screen" id="en_topic_0093011499__screen60038205">GET /v2.0/vpn/vpnservices/{service_id}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en_topic_0093011499__ul169421342153411"><li id="en_topic_0093011499__li12942114213344">Example Response<pre class="screen" id="en_topic_0093011499__screen93641154183418">{
|
|
"vpnservice": {
|
|
"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_0093011499__section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011499__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>
|
|
|