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>
122 lines
12 KiB
HTML
122 lines
12 KiB
HTML
<a name="EN-US_TOPIC_0000001854169233"></a><a name="EN-US_TOPIC_0000001854169233"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About a VPN Endpoint Group</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_section33876408"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p54770906">This API is used to query details about a VPN endpoint group.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_section36452220"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_p1142710172218">GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_table19418153522110" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_row10418143532118"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_p11427103572112">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_0000001854169233__en-us_topic_0000001591896521_p84273352212">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_0000001854169233__en-us_topic_0000001591896521_p242718358217">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_0000001854169233__en-us_topic_0000001591896521_p104271435152111">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_row44271735192115"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_p743473572111">endpoint_group_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_0000001854169233__en-us_topic_0000001591896521_p3434143514215">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_0000001854169233__en-us_topic_0000001591896521_p10434143592116">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_0000001854169233__en-us_topic_0000001591896521_p043443522110">Specifies the ID of the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_section66948675"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_p102334784918">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_section65667169"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_p5610128122216"><a href="#EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_table58761073">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_table58761073"></a><a name="en-us_topic_0000001591896521_en-us_topic_0053740027_table58761073"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_table58761073" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_row2491394"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p476380">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_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p38586810">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_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p33428900">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_row23386368"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p15247616">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_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p27097356">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_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p14377323">Provides supplementary information about the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_row62287048"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p12086140">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_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p39453247">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_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p13871385">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_row57733603"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p45910260">endpoints</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p27743545">List</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p26161025">Specifies the endpoint list. The endpoints in a list must be of the same type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_row34122633"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p12469873">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p3426769">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_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p1565979">Specifies the endpoint type, which can be <strong id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_b1788163213015">subnet</strong> or <strong id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_b488213320304">cidr</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_row14093819"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p748676">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_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p60642794">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_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p56026474">Specifies the ID of the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_row34476226"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p41110918">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_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p41650091">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_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_p66066743">Specifies the name of the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_row13276203720279"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_p1074563802713">endpoint_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_p8745143819271">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_0000001854169233__en-us_topic_0000001591896521_p3746143862716">Specifies the object of the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_section54133615"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_ul2600135920223"><li id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_li17600145910223">Example request<pre class="screen" id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_en-us_topic_0053740027_screen60038205">GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_ul5803063231"><li id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_li5803106142317">Example response<pre class="screen" id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_screen2950916162313">{
|
|
"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-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001854169233__en-us_topic_0000001591896521_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_1047.html">VPN Endpoint Group Management</a></div>
|
|
</div>
|
|
</div>
|
|
|