doc-exports/docs/dc/api-ref/en-dc_topic_0055025340.html
Qin Ying, Fan 00887d3d3c DC API 20230106 version
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2023-04-18 13:55:32 +00:00

195 lines
16 KiB
HTML

<a name="en-dc_topic_0055025340"></a><a name="en-dc_topic_0055025340"></a>
<h1 class="topictitle1">Updating a Direct Connect Endpoint Group</h1>
<div id="body1538013007812"><div class="section" id="en-dc_topic_0055025340__en-us_topic_0070658694_section3515885216025"><h4 class="sectiontitle">Function</h4><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p6128059916025">This API is used to update a Direct Connect endpoint group.</p>
</div>
<div class="section" id="en-dc_topic_0055025340__en-us_topic_0070658694_section616356616025"><h4 class="sectiontitle">URI</h4><p id="en-dc_topic_0055025340__p1622483164213">PUT /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025340__table1297211334365" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-dc_topic_0055025340__row6972123313361"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.3.2.5.1.1"><p id="en-dc_topic_0055025340__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-dc_topic_0055025340__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-dc_topic_0055025340__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-dc_topic_0055025340__p69722339368">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025340__row14972143317361"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-dc_topic_0055025340__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-dc_topic_0055025340__p5972633193614">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-dc_topic_0055025340__p7972193343618">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="42.85571442855714%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-dc_topic_0055025340__p59808335369">Specifies the ID of the Direct Connect endpoint group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025340__en-us_topic_0070658694_section1877718216025"><h4 class="sectiontitle">Request</h4><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p21078426103641"><a href="#en-dc_topic_0055025340__en-us_topic_0070658694_table49278871155710">Table 2</a> lists the request parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025340__en-us_topic_0070658694_table49278871155710"></a><a name="en-us_topic_0070658694_table49278871155710"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025340__en-us_topic_0070658694_table49278871155710" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row34163686155710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="en-dc_topic_0055025340__en-us_topic_0070658694_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-dc_topic_0055025340__en-us_topic_0070658694_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-dc_topic_0055025340__en-us_topic_0070658694_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-dc_topic_0055025340__en-us_topic_0070658694_p34339581155710">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row30042656155710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_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-dc_topic_0055025340__en-us_topic_0070658694_p11133383155710">Dictionary</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p29388827155710">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p31684816155710">Specifies the <strong id="en-dc_topic_0055025340__b842352706201450">dc_endpoint_group</strong> object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025340__en-us_topic_0070658694_table4017731716025" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of field <strong id="en-dc_topic_0055025340__b153280071519">dc_endpoint_group</strong></caption><thead align="left"><tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row2231098116025"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p1547301516025">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p6012563716025">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p1893695816025">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p2817987216025">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row33904501145431"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p61111525145431">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p51086506145431">String</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p44366307145431">No</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p36901113145431">Provides supplementary information about the Direct Connect endpoint group.</p>
<p id="en-dc_topic_0055025340__p83221453713"><span id="en-dc_topic_0055025340__text243011117548">Angle brackets (&lt;&gt;) are not allowed.</span></p>
</td>
</tr>
<tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row63419490145431"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p57365869145431">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p16123817145431">String</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p27720644181110">No</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p24796658145431">Specifies the name of the Direct Connect endpoint group.</p>
<p id="en-dc_topic_0055025340__p35081830113419"><span id="en-dc_topic_0055025340__text15699204710333">Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.</span></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025340__en-us_topic_0070658694_section5537288616025"><h4 class="sectiontitle">Response</h4><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p26072575155835"><a href="#en-dc_topic_0055025340__en-us_topic_0070658694_table33326591155835">Table 4</a> lists the response parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025340__en-us_topic_0070658694_table33326591155835"></a><a name="en-us_topic_0070658694_table33326591155835"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025340__en-us_topic_0070658694_table33326591155835" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameter</caption><thead align="left"><tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row62151438155835"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="en-dc_topic_0055025340__en-us_topic_0070658694_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-dc_topic_0055025340__en-us_topic_0070658694_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-dc_topic_0055025340__en-us_topic_0070658694_p45444133155835">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row57096136155835"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_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-dc_topic_0055025340__en-us_topic_0070658694_p6070383155835">Dictionary</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p32229496155835">Specifies the <strong id="en-dc_topic_0055025340__b84235270620159">dc_endpoint_group</strong> object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025340__en-us_topic_0070658694_table5829218816025" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Description of field <strong id="en-dc_topic_0055025340__b0604912150">dc_endpoint_group</strong></caption><thead align="left"><tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row1193121016025"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p151079216025">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p3945643916025">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p1354606316025">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row45689609145447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p8891931145447">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p49157836145447">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p66476844145447">Specifies the ID of the Direct Connect endpoint group.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row42359325145447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p9020038145447">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p59534515145447">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p32366805145447">Specifies the project ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row41989293145447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p40190072145447">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p34170377145447">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p48243490145447">Specifies the name of the Direct Connect endpoint group.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row12122017145447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p4459976145447">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p25713785145447">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p63571548145447">Provides supplementary information about the Direct Connect endpoint group.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row8803431145447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p38542937145447">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p34970163145447">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p61144149145447">Specifies the list of the endpoints in a Direct Connect endpoint group.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025340__en-us_topic_0070658694_row53173942145447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p13798994145447">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025340__en-us_topic_0070658694_p43976752145447">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025340__p49055421978">Specifies the type of the Direct Connect endpoints. The value can only be <strong id="en-dc_topic_0055025340__b183721449101915">cidr</strong>.</p>
<p id="en-dc_topic_0055025340__p471181218412">Only IPv4 CIDR blocks are supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025340__en-us_topic_0070658694_section5526447416025"><h4 class="sectiontitle">Examples</h4><ul id="en-dc_topic_0055025340__ul156181532184517"><li id="en-dc_topic_0055025340__li0618232134515">Example request<pre class="screen" id="en-dc_topic_0055025340__en-us_topic_0070658694_screen4008476516025">PUT /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}
{
"dc_endpoint_group" : {
"name" : "endpoint group1",
"description" : "New description"
}
}</pre>
</li></ul>
</div>
<ul id="en-dc_topic_0055025340__ul143121643204519"><li id="en-dc_topic_0055025340__li1131215439452">Example response<pre class="screen" id="en-dc_topic_0055025340__screen7696551204519">{
"dc_endpoint_groups" : {
"id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
"tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
"name" : "endpoint group1",
"description" : "New description",
"endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],
"type" : "cidr"
}
}</pre>
</li></ul>
<div class="section" id="en-dc_topic_0055025340__section12113171955820"><h4 class="sectiontitle">Status Codes</h4><p id="en-dc_topic_0055025340__p176816317298">For details, see <a href="en-dc_topic_0055025342.html">Common Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-dc_topic_0055025334.html">Direct Connect Endpoint Group</a></div>
</div>
</div>