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>
169 lines
17 KiB
HTML
169 lines
17 KiB
HTML
<a name="EN-US_TOPIC_0000001807530392"></a><a name="EN-US_TOPIC_0000001807530392"></a>
|
|
|
|
<h1 class="topictitle1">Updating a VPN Endpoint Group</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_section21433709"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p62483297">This API is used to update a VPN endpoint group.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_section58685656"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p108161168263">PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_table19418153522110" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_row10418143532118"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p11427103572112">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p84273352212">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p242718358217">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p104271435152111">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_row44271735192115"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p743473572111">endpoint_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p3434143514215">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p10434143592116">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p043443522110">Specifies the ID of the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_section55917699"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p13307101015270"><a href="#EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_table16221316">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_table16221316"></a><a name="en-us_topic_0000001591736533_en-us_topic_0053740031_table16221316"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_table16221316" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_row20649961"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p62034116">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p58707504">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p57687380">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p42166233">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_row58467488"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p38246063">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p10923387">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p12379115">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p63184231">Provides supplementary information about the VPN endpoint group.</p>
|
|
<p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p152577913314">The description can contain up to 255 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_row31787174"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p24624288">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p48410331">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p28922751">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p61041458">Specifies the name of the VPN endpoint group.</p>
|
|
<p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p177935793019">The name can contain 1 to 64 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_row523519151590"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p5871161710719">endpoint_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p178711817274">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p38718171972">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p48711317678">Specifies the endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_note268345013266"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p2135163644114">Parameter <strong id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_b8474112110345">project_id</strong> is not supported.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_section33497244"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p068883719278"><a href="#EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_table45411103">Table 3</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_table45411103"></a><a name="en-us_topic_0000001591736533_en-us_topic_0053740031_table45411103"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_table45411103" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_row48031108"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p65314517">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p55984556">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p27859461">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_row42023897"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p48492497">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_0000001807530392__en-us_topic_0000001591736533_p36681140202917">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p23930149">Provides supplementary information about the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_row14044750"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p63882937">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_0000001807530392__en-us_topic_0000001591736533_p46691340102917">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p40569470">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_row29580916"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p47244029">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_0000001807530392__en-us_topic_0000001591736533_p866924020295">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p42136306">Specifies the endpoint list. The endpoints in a list must be of the same type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_row43682438"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p48616614">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_0000001807530392__en-us_topic_0000001591736533_p1966912408293">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p16804345">Specifies the endpoint type, which can be <strong id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_b06402386344">subnet</strong> or <strong id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_b11642133823417">cidr</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_row17021380"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p36554565">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_0000001807530392__en-us_topic_0000001591736533_p196691240122915">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p55361044">Specifies the ID of the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_row28487351"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p25774132">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_0000001807530392__en-us_topic_0000001591736533_p1166918409299">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_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_p41771788">Provides supplementary information about the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_row1257172515297"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p4383192682913">endpoint_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_p18669440152917">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_0000001807530392__en-us_topic_0000001591736533_p73842262298">Specifies the object of the VPN endpoint group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_section33039746"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_ul339321182816"><li id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_li839316116284">Example request<pre class="screen" id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_en-us_topic_0053740031_screen21336517215226">PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}
|
|
{
|
|
"endpoint_group" : {
|
|
"description" : "New description"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_ul13191313142816"><li id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_li919101352816">Example response<pre class="screen" id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_screen1938510215287">{
|
|
"endpoint_group" : {
|
|
"description" : "New 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_0000001807530392__en-us_topic_0000001591736533_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001807530392__en-us_topic_0000001591736533_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>
|
|
|