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>
155 lines
13 KiB
HTML
155 lines
13 KiB
HTML
<a name="en-us_topic_0055025339"></a><a name="en-us_topic_0055025339"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Direct Connect Endpoint Group</h1>
|
|
<div id="body1538013006336"><div class="section" id="en-us_topic_0055025339__en-us_topic_0070658800_section17487184"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0055025339__en-us_topic_0070658800_p51221589">This API is used to query a Direct Connect endpoint group.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025339__en-us_topic_0070658800_section23166934"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0055025339__p3935945143710">GET /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025339__table1297211334365" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0055025339__row6972123313361"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.3.2.5.1.1"><p id="en-us_topic_0055025339__p7972133143612">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.42785721427857%" id="mcps1.3.2.3.2.5.1.2"><p id="en-us_topic_0055025339__p997213303616">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.2.3.2.5.1.3"><p id="en-us_topic_0055025339__p597215330365">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.85571442855714%" id="mcps1.3.2.3.2.5.1.4"><p id="en-us_topic_0055025339__p69722339368">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025339__row14972143317361"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-us_topic_0055025339__p0972633143618">endpoint_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en-us_topic_0055025339__p5972633193614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-us_topic_0055025339__p7972193343618">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.85571442855714%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-us_topic_0055025339__p59808335369">Specifies the ID of the Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025339__en-us_topic_0070658800_section64582388"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0055025339__p06966633820"><a href="#en-us_topic_0055025339__en-us_topic_0070658800_table2198437322244">Table 2</a> lists the request parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025339__en-us_topic_0070658800_table2198437322244"></a><a name="en-us_topic_0070658800_table2198437322244"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025339__en-us_topic_0070658800_table2198437322244" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="en-us_topic_0055025339__en-us_topic_0070658800_row4304807922244"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="en-us_topic_0055025339__en-us_topic_0070658800_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_0055025339__en-us_topic_0070658800_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_0055025339__en-us_topic_0070658800_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_0055025339__en-us_topic_0070658800_p5470821922244">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025339__en-us_topic_0070658800_row5451891922244"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p5675124985931">endpoint_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_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_0055025339__en-us_topic_0070658800_p4706384922316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p970883222316">Specifies the ID of the Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025339__en-us_topic_0070658800_section44370581"><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0055025339__en-us_topic_0070658800_p26072575155835"><a href="#en-us_topic_0055025339__en-us_topic_0070658800_table33326591155835">Table 3</a> lists the response parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025339__en-us_topic_0070658800_table33326591155835"></a><a name="en-us_topic_0070658800_table33326591155835"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025339__en-us_topic_0070658800_table33326591155835" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter</caption><thead align="left"><tr id="en-us_topic_0055025339__en-us_topic_0070658800_row62151438155835"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="en-us_topic_0055025339__en-us_topic_0070658800_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_0055025339__en-us_topic_0070658800_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_0055025339__en-us_topic_0070658800_p45444133155835">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025339__en-us_topic_0070658800_row57096136155835"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p61384275155835">dc_endpoint_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p6070383155835">Dictionary</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p32229496155835">Specifies the <strong id="en-us_topic_0055025339__b84235270692654">dc_endpoint_group</strong> object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025339__en-us_topic_0070658800_table14681450" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of field <strong id="en-us_topic_0055025339__b1994318548146">dc_endpoint_group</strong></caption><thead align="left"><tr id="en-us_topic_0055025339__en-us_topic_0070658800_row21069217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="en-us_topic_0055025339__en-us_topic_0070658800_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_0055025339__en-us_topic_0070658800_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_0055025339__en-us_topic_0070658800_p4499576">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025339__en-us_topic_0070658800_row6614602622620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p53899497155718">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p27469194155718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p46888307155718">Specifies the ID of the Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025339__en-us_topic_0070658800_row4620915422620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p9842188155718">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_0055025339__en-us_topic_0070658800_p66208886155718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p48740843155718">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025339__en-us_topic_0070658800_row1146602622620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p43439215155718">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p51799105155718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p24601733155718">Specifies the name of the Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025339__en-us_topic_0070658800_row2411573022620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p61357604155718">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p30641944155718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p42009298155718">Provides supplementary information about the Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025339__en-us_topic_0070658800_row1544898622620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p6403812155718">endpoints</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p15708548155718">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_0055025339__en-us_topic_0070658800_p21827696155718">Specifies the list of the endpoints in a Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025339__en-us_topic_0070658800_row1078246722620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p9214955155718">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025339__en-us_topic_0070658800_p4021487155718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025339__p1515314494119">Specifies the type of the Direct Connect endpoints. The value can only be <strong id="en-us_topic_0055025339__b14931040101910">cidr</strong>.</p>
|
|
<p id="en-us_topic_0055025339__en-us_topic_0070658700_p54361932151030">Only IPv4 CIDR blocks are supported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025339__en-us_topic_0070658800_section63790914"><h4 class="sectiontitle">Examples</h4><ul id="en-us_topic_0055025339__ul3323144116392"><li id="en-us_topic_0055025339__li14323114118398">Example request<pre class="screen" id="en-us_topic_0055025339__en-us_topic_0070658800_screen15604521">GET /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en-us_topic_0055025339__ul4503359143915"><li id="en-us_topic_0055025339__li18503175923911">Example response<pre class="screen" id="en-us_topic_0055025339__screen3676187164016">{
|
|
"dc_endpoint_group" : {
|
|
"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_0055025339__section12113171955820"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0055025339__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>
|
|
|