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>
198 lines
14 KiB
HTML
198 lines
14 KiB
HTML
<a name="en-us_topic_0055025333"></a><a name="en-us_topic_0055025333"></a>
|
|
|
|
<h1 class="topictitle1">Updating a Virtual Interface</h1>
|
|
<div id="body1495543735580"><div class="section" id="en-us_topic_0055025333__section20784174143924"><a name="en-us_topic_0055025333__section20784174143924"></a><a name="section20784174143924"></a><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0055025333__p10695382143924">This API is used to update a virtual interface.</p>
|
|
<div class="note" id="en-us_topic_0055025333__note1627158124"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody">
|
|
<p id="en-us_topic_0055025333__p28884251017">The bandwidth specified for a virtual interface associated with a standard connection can be increased or decreased, but the bandwidth specified for a virtual interface associated with a hosted connection cannot be changed.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025333__section11530146143924"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0055025333__p1996348112">PUT /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025333__table1222245015813" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0055025333__row12230205015819"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.3.2.5.1.1"><p id="en-us_topic_0055025333__p162305501281">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_0055025333__p9230650285">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_0055025333__p19230450783">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_0055025333__p152371550289">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025333__row023735012814"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-us_topic_0055025333__p2023716501788">virtual_interface_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_0055025333__p123716501816">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_0055025333__p4244175012817">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_0055025333__p1624475015815">Specifies the virtual interface ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025333__section17286486143924"><a name="en-us_topic_0055025333__section17286486143924"></a><a name="section17286486143924"></a><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0055025333__p21078426103641"><a href="#en-us_topic_0055025333__table10476506155243">Table 2</a> lists the request parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025333__table10476506155243"></a><a name="table10476506155243"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025333__table10476506155243" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="en-us_topic_0055025333__row28606500155243"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="en-us_topic_0055025333__p28732152155335">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.3.2.5.1.2"><p id="en-us_topic_0055025333__p45602971155335">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.3.2.5.1.3"><p id="en-us_topic_0055025333__p2853179155335">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43%" id="mcps1.3.3.3.2.5.1.4"><p id="en-us_topic_0055025333__p29780927155335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025333__row17724599155243"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-us_topic_0055025333__p26406454155243">virtual_interface</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-us_topic_0055025333__p58548062155243">Dictionary</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-us_topic_0055025333__p44772566155243">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-us_topic_0055025333__p2699206155243">Specifies the <strong id="en-us_topic_0055025333__b842352706194219">virtual_interface</strong> object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025333__table41417936143924" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of field <strong id="en-us_topic_0055025333__b732719262014">virtual_interface</strong></caption><thead align="left"><tr id="en-us_topic_0055025333__row60831409143924"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="en-us_topic_0055025333__p38838355143924">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.4.2.5.1.2"><p id="en-us_topic_0055025333__p63189637143924">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.4.2.5.1.3"><p id="en-us_topic_0055025333__p49522103143924">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43%" id="mcps1.3.3.4.2.5.1.4"><p id="en-us_topic_0055025333__p21616645143924">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025333__row18728126143924"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025333__p7948256143924">virtual_interface_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025333__p56200600143924">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025333__p56692166143924">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025333__p45478774143924">Specifies the virtual interface ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025333__row22103264145316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025333__p949640145316">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025333__p9812033145316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025333__p56577178145316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025333__p19348667145316">Provides supplementary information about the virtual interface.</p>
|
|
<p id="en-us_topic_0055025333__p1531741441"><span id="en-us_topic_0055025333__text243011117548">Angle brackets (<>) are not allowed.</span></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025333__row62108241145316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025333__p12317111145316">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025333__p58161973145316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025333__p13499383145316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025333__p19708262145316">Specifies the virtual interface name.</p>
|
|
<p id="en-us_topic_0055025333__p35081830113419"><span id="en-us_topic_0055025333__text15699204710333">Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.</span></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025333__row25467370204329"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025333__p9417538204337">bandwidth</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025333__p24623126204337">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025333__p48316153204337">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025333__p21294358204337">Specifies the virtual interface bandwidth.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025333__row15734375145352"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025333__p5702622145352">remote_ep_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025333__p59259247145352">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025333__p35269704145352">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025333__p38273810145352">Specifies the ID of the remote endpoint group that records the CIDR blocks used by the on-premises network.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025333__section33278910143924"><a name="en-us_topic_0055025333__section33278910143924"></a><a name="section33278910143924"></a><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0055025333__p2714668115724"><a href="#en-us_topic_0055025333__table2216502815556">Table 4</a> lists the response parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025333__table2216502815556"></a><a name="table2216502815556"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025333__table2216502815556" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameter</caption><thead align="left"><tr id="en-us_topic_0055025333__row2118154015556"><th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.4.3.2.4.1.1"><p id="en-us_topic_0055025333__p3798321415556">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.3.2.4.1.2"><p id="en-us_topic_0055025333__p5674152115556">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.3.2.4.1.3"><p id="en-us_topic_0055025333__p2825222315556">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025333__row672873115556"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025333__p815633515556">virtual_interface</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025333__p5668342815556">Dictionary</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025333__p4976072015556">Specifies the <strong id="en-us_topic_0055025333__b842352706194240">virtual_interface</strong> object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="en-us_topic_0055025333__p18191225165914">For details about the <strong id="en-us_topic_0055025333__b2434111514912">virtual_interface</strong> field, see <a href="en-us_topic_0055025328.html#en-us_topic_0055025328__en-us_topic_0070658680_table1529059104553">Table 1</a>.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025333__section9931099143924"><a name="en-us_topic_0055025333__section9931099143924"></a><a name="section9931099143924"></a><h4 class="sectiontitle">Examples</h4><ul id="en-us_topic_0055025333__ul19574201521411"><li id="en-us_topic_0055025333__li257441501420">Example request<pre class="screen" id="en-us_topic_0055025333__screen44926974143924">PUT /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}
|
|
{
|
|
"virtual_interface" : {
|
|
"name" : "virtual interface1",
|
|
"description" : "New description"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="en-us_topic_0055025333__ul2072310282147"><li id="en-us_topic_0055025333__li57231428151411">Example response<pre class="screen" id="en-us_topic_0055025333__screen55871140151413">{
|
|
"virtual_interface" : {
|
|
"id": "634c61d0-fd7b-4961-adb6-37a2e3c42d08",
|
|
"name": "virtual-interface1",
|
|
"description": "New description",
|
|
"tenant_id": "06057682ed80d5762f25c00b5deb794a",
|
|
"direct_connect_id": "73707953-df69-4d03-8df5-b46a087c1424",
|
|
"vgw_id": "9b5cab66-7634-4213-8d01-fa37cb908e12",
|
|
"type": "private",
|
|
"service_type": "vpc",
|
|
"vlan": 687,
|
|
"bandwidth": 2,
|
|
"local_gateway_v4_ip": "11.11.11.1/30",
|
|
"remote_gateway_v4_ip": "11.11.11.2/30",
|
|
"route_mode": "static",
|
|
"bgp_asn": null,
|
|
"bgp_md5": null,
|
|
"remote_ep_group_id": "a2b81f07-826f-40b0-9e8d-17d1af5230cf",
|
|
"service_ep_group_id": null,
|
|
"status": "ACTIVE",
|
|
"create_time": "2021-12-15T08:31:27Z",
|
|
"admin_state_up": true,
|
|
"rate_limit": false,
|
|
"enable_bfd": false,
|
|
"health_check_source_ip": null,
|
|
"route_limit": 50,
|
|
"address_family": "ipv4",
|
|
"local_gateway_v6_ip": null,
|
|
"remote_gateway_v6_ip": null,
|
|
"region_id": null,
|
|
"enable_nqa": false,
|
|
"enable_gre": false,
|
|
"local_gre_tunnel_ip": null,
|
|
"remote_gre_tunnel_ip": null,
|
|
"lag_id": null
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="en-us_topic_0055025333__section38874431173428"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0055025333__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_0055025327.html">Virtual Interface</a></div>
|
|
</div>
|
|
</div>
|
|
|