forked from docs/doc-exports
Qin Ying, Fan
62ab8a5fe2
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
136 lines
12 KiB
HTML
136 lines
12 KiB
HTML
<a name="en-us_topic_0055025337"></a><a name="en-us_topic_0055025337"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Direct Connect Endpoint Group List</h1>
|
|
<div id="body1538013003624"><div class="section" id="en-us_topic_0055025337__en-us_topic_0070658771_section17487184"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0055025337__en-us_topic_0070658771_p51221589">This API is used to query the Direct Connect endpoint group list.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025337__en-us_topic_0070658771_section23166934"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0055025337__p184416307324">GET /v2.0/dcaas/dc-endpoint-groups</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025337__en-us_topic_0070658771_section64582388"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0055025337__p46887519337"><a href="#en-us_topic_0055025337__en-us_topic_0070658771_table2198437322244">Table 1</a> lists the request parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025337__en-us_topic_0070658771_table2198437322244"></a><a name="en-us_topic_0070658771_table2198437322244"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025337__en-us_topic_0070658771_table2198437322244" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="en-us_topic_0055025337__en-us_topic_0070658771_row4304807922244"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="en-us_topic_0055025337__en-us_topic_0070658771_p6505580022244">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="en-us_topic_0055025337__en-us_topic_0070658771_p329696222244">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="en-us_topic_0055025337__en-us_topic_0070658771_p3257067222244">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="en-us_topic_0055025337__en-us_topic_0070658771_p5470821922244">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025337__en-us_topic_0070658771_row5451891922244"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p6157819622316">fields</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p757920222316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p4706384922316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p6336462419813">Specifies the parameters expected to be returned.</p>
|
|
<p id="en-us_topic_0055025337__en-us_topic_0070658771_p970883222316">If you do not specify it, all parameters will be returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025337__en-us_topic_0070658771_section44370581"><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0055025337__en-us_topic_0070658771_p26072575155835"><a href="#en-us_topic_0055025337__en-us_topic_0070658771_table33326591155835">Table 2</a> lists the response parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025337__en-us_topic_0070658771_table33326591155835"></a><a name="en-us_topic_0070658771_table33326591155835"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025337__en-us_topic_0070658771_table33326591155835" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="en-us_topic_0055025337__en-us_topic_0070658771_row62151438155835"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="en-us_topic_0055025337__en-us_topic_0070658771_p1101727155835">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="en-us_topic_0055025337__en-us_topic_0070658771_p22131064155835">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="en-us_topic_0055025337__en-us_topic_0070658771_p45444133155835">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025337__en-us_topic_0070658771_row57096136155835"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p61384275155835">dc_endpoint_groups</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p6070383155835">List</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p32229496155835">Specifies the Direct Connect endpoint group list.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025337__en-us_topic_0070658771_table14681450" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of field <strong id="en-us_topic_0055025337__en-us_topic_0070658771_b8423527069345">dc_endpoint_groups</strong></caption><thead align="left"><tr id="en-us_topic_0055025337__en-us_topic_0070658771_row21069217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="en-us_topic_0055025337__en-us_topic_0070658771_p28885026">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="en-us_topic_0055025337__en-us_topic_0070658771_p57985771">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="en-us_topic_0055025337__en-us_topic_0070658771_p4499576">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025337__en-us_topic_0070658771_row6614602622620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p34388252153945">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p44319756153945">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p46242397153945">Specifies the ID of the Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025337__en-us_topic_0070658771_row4620915422620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p5791372153945">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p50586028153945">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p27138588153945">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025337__en-us_topic_0070658771_row1146602622620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p42210218153945">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p46108179153945">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p43058442153945">Specifies the name of the Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025337__en-us_topic_0070658771_row2411573022620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p46605694153945">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p21469085153945">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p39581077153945">Provides supplementary information about the Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025337__en-us_topic_0070658771_row1544898622620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p59760215153945">endpoints</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p17154880153945">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p8000696153945">Specifies the list of the endpoints in a Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025337__en-us_topic_0070658771_row1078246722620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p59917406153945">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p67030345153945">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025337__en-us_topic_0070658771_p14175732153945">Specifies the type of the Direct Connect endpoints. The value can only be <strong id="en-us_topic_0055025337__b1970183313193">cidr</strong>.</p>
|
|
<p id="en-us_topic_0055025337__p9276557184017">Only IPv4 CIDR blocks are supported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025337__en-us_topic_0070658771_section63790914"><h4 class="sectiontitle">Examples</h4><ul id="en-us_topic_0055025337__en-us_topic_0070658771_ul24802238111916"><li id="en-us_topic_0055025337__li51134217341">Example request<ol id="en-us_topic_0055025337__ol1655715533418"><li id="en-us_topic_0055025337__li3557165563418">Querying all Direct Connect endpoint groups</li></ol>
|
|
<pre class="screen" id="en-us_topic_0055025337__screen855745553416">GET /v2.0/dcaas/dc-endpoint-groups</pre>
|
|
<ol start="2" id="en-us_topic_0055025337__ol162944619354"><li id="en-us_topic_0055025337__li162946653512">Querying a Direct Connect endpoint group by ID</li></ol>
|
|
<pre class="screen" id="en-us_topic_0055025337__screen22940683518">GET /v2.0/dcaas/dc-endpoint-groups?id=6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en-us_topic_0055025337__ul19990191613516"><li id="en-us_topic_0055025337__li599031633512">Example response<pre class="screen" id="en-us_topic_0055025337__screen1891962619358">{
|
|
"dc_endpoint_groups" : [{
|
|
"id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
|
|
"tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
|
|
"name" : "endpoint group1",
|
|
"description" : "",
|
|
"endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],
|
|
"type" : "cidr"
|
|
}]
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en-us_topic_0055025337__section1148118488575"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0055025337__p176816317298">For details, see <a href="en-us_topic_0055025342.html">Common Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0055025334.html">Direct Connect Endpoint Group</a></div>
|
|
</div>
|
|
</div>
|
|
|