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>
201 lines
17 KiB
HTML
201 lines
17 KiB
HTML
<a name="en-us_topic_0055025336"></a><a name="en-us_topic_0055025336"></a>
|
|
|
|
<h1 class="topictitle1">Creating an Endpoint Group</h1>
|
|
<div id="body1538012999013"><div class="section" id="en-us_topic_0055025336__en-us_topic_0070658700_section6324186692910"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0055025336__en-us_topic_0070658700_p2106791092910">This API is used to create a Direct Connect endpoint group.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025336__en-us_topic_0070658700_section853188092910"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0055025336__p1215081014169">POST /v2.0/dcaas/dc-endpoint-groups</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025336__en-us_topic_0070658700_section2281784192910"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0055025336__en-us_topic_0070658700_p21078426103641"><a href="#en-us_topic_0055025336__en-us_topic_0070658700_table49278871155710">Table 1</a> lists the request parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025336__en-us_topic_0070658700_table49278871155710"></a><a name="en-us_topic_0070658700_table49278871155710"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025336__en-us_topic_0070658700_table49278871155710" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="en-us_topic_0055025336__en-us_topic_0070658700_row34163686155710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="en-us_topic_0055025336__en-us_topic_0070658700_p15795191155710">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_0055025336__en-us_topic_0070658700_p4342096155710">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_0055025336__en-us_topic_0070658700_p16165530155710">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_0055025336__en-us_topic_0070658700_p34339581155710">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025336__en-us_topic_0070658700_row30042656155710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p17536043155710">dc_endpoint_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p11133383155710">Dictionary</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p29388827155710">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p31684816155710">Specifies the <strong id="en-us_topic_0055025336__b842352706194419">dc_endpoint_group</strong> object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025336__en-us_topic_0070658700_table3523051192910" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Description of field <strong id="en-us_topic_0055025336__en-us_topic_0070658694_b8423527069345">dc_endpoint_group</strong></caption><thead align="left"><tr id="en-us_topic_0055025336__en-us_topic_0070658700_row1307920992910"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="en-us_topic_0055025336__en-us_topic_0070658700_p4450739192910">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="en-us_topic_0055025336__en-us_topic_0070658700_p26394292910">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="en-us_topic_0055025336__en-us_topic_0070658700_p6472145192910">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="en-us_topic_0055025336__en-us_topic_0070658700_p6443764692910">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025336__en-us_topic_0070658700_row2660185192910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p3605816293239">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p6629905993311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p5941630693257">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p1074630693412">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025336__en-us_topic_0070658700_row2405214492910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p1588715393239">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p2631109893311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p1210552293257">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p464917193412">Specifies the name of the Direct Connect endpoint group.</p>
|
|
<p id="en-us_topic_0055025336__p35081830113419"><span id="en-us_topic_0055025336__text15699204710333">Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.</span></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025336__en-us_topic_0070658700_row5264583392910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p4444139293239">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p45532693311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p3573563593257">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p6458631593412">Provides supplementary information about the Direct Connect endpoint group.</p>
|
|
<p id="en-us_topic_0055025336__p751313518"><span id="en-us_topic_0055025336__text243011117548">Angle brackets (<>) are not allowed.</span></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025336__en-us_topic_0070658700_row677461492910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p65056527151044">endpoints</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p28152132151058">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p6711601151030">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p59601471151030">Specifies the list of the endpoints in a Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025336__en-us_topic_0070658700_row2673906492910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p13276033151044">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p59598963151058">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p25798842151030">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025336__p224162912391">Specifies the type of the Direct Connect endpoints. The value can only be <strong id="en-us_topic_0055025336__b119326237184">cidr</strong>.</p>
|
|
<p id="en-us_topic_0055025336__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_0055025336__en-us_topic_0070658700_section1915447592910"><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0055025336__en-us_topic_0070658700_p26072575155835"><a href="#en-us_topic_0055025336__en-us_topic_0070658700_table33326591155835">Table 3</a> lists the response parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025336__en-us_topic_0070658700_table33326591155835"></a><a name="en-us_topic_0070658700_table33326591155835"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025336__en-us_topic_0070658700_table33326591155835" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter</caption><thead align="left"><tr id="en-us_topic_0055025336__en-us_topic_0070658700_row62151438155835"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="en-us_topic_0055025336__en-us_topic_0070658700_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_0055025336__en-us_topic_0070658700_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_0055025336__en-us_topic_0070658700_p45444133155835">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025336__en-us_topic_0070658700_row57096136155835"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_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_0055025336__en-us_topic_0070658700_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_0055025336__en-us_topic_0070658700_p32229496155835">Specifies the <strong id="en-us_topic_0055025336__b842352706194437">dc_endpoint_group</strong> object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025336__en-us_topic_0070658700_table6599744292910" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of field <strong id="en-us_topic_0055025336__b96111451642">dc_endpoint_group</strong></caption><thead align="left"><tr id="en-us_topic_0055025336__en-us_topic_0070658700_row1344591292910"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="en-us_topic_0055025336__en-us_topic_0070658700_p4888289392910">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_0055025336__en-us_topic_0070658700_p228436892910">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_0055025336__en-us_topic_0070658700_p1567805992910">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025336__en-us_topic_0070658700_row557857592910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p2232642692910">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p4674730592910">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p5414758192910">Specifies the ID of the Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025336__en-us_topic_0070658700_row2072208492910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p40455487151221">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_0055025336__en-us_topic_0070658700_p49548139151221">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p14127953151221">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025336__en-us_topic_0070658700_row2092257692910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p60451660151221">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p8044767151221">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p2878368151221">Specifies the name of the Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025336__en-us_topic_0070658700_row404465492910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p29866301151221">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p14174295151221">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p14446635151221">Provides supplementary information about the Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025336__en-us_topic_0070658700_row611136292910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p42150997151221">endpoints</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p60404427151221">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_0055025336__en-us_topic_0070658700_p39362491151221">Specifies the list of the endpoints in a Direct Connect endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025336__en-us_topic_0070658700_row4800353492910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p5385967151221">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0055025336__en-us_topic_0070658700_p34948125151221">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0055025336__p116191035134019">Specifies the type of the Direct Connect endpoints. The value can only be <strong id="en-us_topic_0055025336__b9233142615194">cidr</strong>.</p>
|
|
<p id="en-us_topic_0055025336__en-us_topic_0070658700_p56273146151221">Only IPv4 CIDR blocks are supported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025336__en-us_topic_0070658700_section5174176392910"><h4 class="sectiontitle">Examples</h4><ul id="en-us_topic_0055025336__ul11667164853116"><li id="en-us_topic_0055025336__li06677488315">Example request<pre class="screen" id="en-us_topic_0055025336__en-us_topic_0070658700_screen2013533392910">POST /v2.0/dcaas/dc-endpoint-groups
|
|
{
|
|
"dc_endpoint_group" : {
|
|
"name" : "endpoint group1",
|
|
"endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],
|
|
"type" : "cidr"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en-us_topic_0055025336__ul1160716373210"><li id="en-us_topic_0055025336__li5607432326">Example response<pre class="screen" id="en-us_topic_0055025336__screen34365139320">{
|
|
"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_0055025336__section7887155395216"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0055025336__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>
|
|
|