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>
136 lines
13 KiB
HTML
136 lines
13 KiB
HTML
<a name="EN-US_TOPIC_0000001854089285"></a><a name="EN-US_TOPIC_0000001854089285"></a>
|
|
|
|
<h1 class="topictitle1">Querying VPN Endpoint Groups</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_section45028263"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p17398306">This API is used to query VPN endpoint groups.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_section2601186"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_p1840783716234">GET /v2.0/vpn/endpoint-groups</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_section9369539"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_p55213146243"><a href="#EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_table20501377">Table 1</a> describes the request parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_table20501377"></a><a name="en-us_topic_0000001591736529_en-us_topic_0053740015_table20501377"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_table20501377" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_row59628243"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p65158399">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-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p43339000">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-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p20798117">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-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p6925935">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_row24129853"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p8361080">fields</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p6158855">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p29105235">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p8713795">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-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_note181641755172314"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_p1864215554236">Parameter <strong id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_b14276184283114">project_id</strong> is not supported.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_section17216995"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_p1984411348245"><a href="#EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_table34728767">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_table34728767"></a><a name="en-us_topic_0000001591736529_en-us_topic_0053740015_table34728767"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_table34728767" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_row34760343"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p64124362">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p26690871">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p31780825">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_row24110047"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p6756797">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p10429724">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p45492604">Provides supplementary information about the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_row6780253"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p12329649">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p59177513">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p38888871">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_row14455523"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p30046694">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p17863121">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p27863937">Specifies the endpoint list. The endpoints in a list must be of the same type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_row49448848"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p45933772">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p29648085">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p39601516">Specifies the endpoint type, which can be <strong id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_b21972023317">subnet</strong> or <strong id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_b91987033312">cidr</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_row20869327"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p12693918">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p21574462">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p17455632">Specifies the ID of the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_row22882960"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p41580444">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p12572829">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_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_p13543581">Specifies the name of the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_row1117942132818"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_p31564372816">endpoint_groups</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_p1815943192817">List<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_0000001854089285__en-us_topic_0000001591736529_p18151343182812">Specifies the object of the VPN endpoint groups.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_section20735233"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_ul124411728172516"><li id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_li1444132810251">Example request<pre class="screen" id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_en-us_topic_0053740015_screen10956331">GET /v2.0/vpn/endpoint-groups</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_ul13838133592519"><li id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_li18381357251">Example response<pre class="screen" id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_screen1734813474256">{
|
|
"endpoint_groups": [
|
|
{
|
|
"description": "",
|
|
"tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d",
|
|
"endpoints": [
|
|
"a3da778c-adfb-46db-88b3-d2ce53290a89"
|
|
],
|
|
"type": "subnet",
|
|
"id": "6bf34c7c-864c-4948-a6d4-db791669f9d4",
|
|
"name": "locals"
|
|
},
|
|
{
|
|
"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_0000001854089285__en-us_topic_0000001591736529_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001854089285__en-us_topic_0000001591736529_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>
|
|
|