vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dc/api-ref/en-dc_topic_0055025333.html
Qin Ying, Fan 4a7d4f4cd8 DC API 0930 version 
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2022-10-06 09:33:01 +00:00

361 lines
29 KiB
HTML
Raw Blame History

<a name="en-dc_topic_0055025333"></a><a name="en-dc_topic_0055025333"></a>
<h1 class="topictitle1">Updating a Virtual Interface</h1>
<div id="body1495543735580"><div class="section" id="en-dc_topic_0055025333__section20784174143924"><h4 class="sectiontitle">Function</h4><p id="en-dc_topic_0055025333__p10695382143924">This API is used to update a virtual interface.</p>
<div class="note" id="en-dc_topic_0055025333__note1627158124"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="en-dc_topic_0055025333__ul2555132141814"><li id="en-dc_topic_0055025333__li75551332111817">You can only increase the bandwidth.</li><li id="en-dc_topic_0055025333__li05551932131816">Virtual interface bandwidths of hosted direct connections cannot be updated.</li></ul>
</div></div>
</div>
<div class="section" id="en-dc_topic_0055025333__section11530146143924"><h4 class="sectiontitle">URI</h4><p id="en-dc_topic_0055025333__p1996348112">PUT /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025333__table1222245015813" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-dc_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-dc_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-dc_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-dc_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-dc_topic_0055025333__p152371550289">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025333__row023735012814"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-dc_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-dc_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-dc_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-dc_topic_0055025333__p1624475015815">Specifies the virtual interface ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025333__section17286486143924"><h4 class="sectiontitle">Request</h4><p id="en-dc_topic_0055025333__p21078426103641"><a href="#en-dc_topic_0055025333__table10476506155243">Table 2</a> lists the request parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025333__table10476506155243"></a><a name="table10476506155243"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025333__table10476506155243" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="en-dc_topic_0055025333__row28606500155243"><th align="left" class="cellrowborder" valign="top" width="29.299999999999997%" id="mcps1.3.3.3.2.5.1.1"><p id="en-dc_topic_0055025333__p28732152155335">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.060000000000002%" id="mcps1.3.3.3.2.5.1.2"><p id="en-dc_topic_0055025333__p45602971155335">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.310000000000002%" id="mcps1.3.3.3.2.5.1.3"><p id="en-dc_topic_0055025333__p2853179155335">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31.330000000000002%" id="mcps1.3.3.3.2.5.1.4"><p id="en-dc_topic_0055025333__p29780927155335">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025333__row17724599155243"><td class="cellrowborder" valign="top" width="29.299999999999997%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-dc_topic_0055025333__p26406454155243">virtual_interface</p>
</td>
<td class="cellrowborder" valign="top" width="21.060000000000002%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-dc_topic_0055025333__p58548062155243">Dictionary data structure</p>
</td>
<td class="cellrowborder" valign="top" width="18.310000000000002%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-dc_topic_0055025333__p44772566155243">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="31.330000000000002%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-dc_topic_0055025333__p2699206155243">Specifies the <strong id="en-dc_topic_0055025333__b842352706194219">virtual_interface</strong> object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025333__table41417936143924" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of field <strong id="en-dc_topic_0055025333__b732719262014">virtual_interface</strong></caption><thead align="left"><tr id="en-dc_topic_0055025333__row60831409143924"><th align="left" class="cellrowborder" valign="top" width="29.590000000000003%" id="mcps1.3.3.4.2.5.1.1"><p id="en-dc_topic_0055025333__p38838355143924">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.35%" id="mcps1.3.3.4.2.5.1.2"><p id="en-dc_topic_0055025333__p63189637143924">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.09%" id="mcps1.3.3.4.2.5.1.3"><p id="en-dc_topic_0055025333__p49522103143924">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.970000000000002%" id="mcps1.3.3.4.2.5.1.4"><p id="en-dc_topic_0055025333__p21616645143924">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025333__row18728126143924"><td class="cellrowborder" valign="top" width="29.590000000000003%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-dc_topic_0055025333__p7948256143924">virtual_interface_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.35%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-dc_topic_0055025333__p56200600143924">String</p>
</td>
<td class="cellrowborder" valign="top" width="19.09%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-dc_topic_0055025333__p56692166143924">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="30.970000000000002%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-dc_topic_0055025333__p45478774143924">Specifies the virtual interface ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row22103264145316"><td class="cellrowborder" valign="top" width="29.590000000000003%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-dc_topic_0055025333__p949640145316">description</p>
</td>
<td class="cellrowborder" valign="top" width="20.35%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-dc_topic_0055025333__p9812033145316">String</p>
</td>
<td class="cellrowborder" valign="top" width="19.09%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-dc_topic_0055025333__p56577178145316">No</p>
</td>
<td class="cellrowborder" valign="top" width="30.970000000000002%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-dc_topic_0055025333__p19348667145316">Provides supplementary information about the virtual interface.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row62108241145316"><td class="cellrowborder" valign="top" width="29.590000000000003%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-dc_topic_0055025333__p12317111145316">name</p>
</td>
<td class="cellrowborder" valign="top" width="20.35%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-dc_topic_0055025333__p58161973145316">String</p>
</td>
<td class="cellrowborder" valign="top" width="19.09%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-dc_topic_0055025333__p13499383145316">No</p>
</td>
<td class="cellrowborder" valign="top" width="30.970000000000002%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-dc_topic_0055025333__p19708262145316">Specifies the virtual interface name.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row25467370204329"><td class="cellrowborder" valign="top" width="29.590000000000003%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-dc_topic_0055025333__p9417538204337">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="20.35%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-dc_topic_0055025333__p24623126204337">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="19.09%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-dc_topic_0055025333__p48316153204337">No</p>
</td>
<td class="cellrowborder" valign="top" width="30.970000000000002%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-dc_topic_0055025333__p21294358204337">Specifies the virtual interface bandwidth.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row15734375145352"><td class="cellrowborder" valign="top" width="29.590000000000003%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-dc_topic_0055025333__p5702622145352">remote_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.35%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-dc_topic_0055025333__p59259247145352">String</p>
</td>
<td class="cellrowborder" valign="top" width="19.09%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-dc_topic_0055025333__p35269704145352">No</p>
</td>
<td class="cellrowborder" valign="top" width="30.970000000000002%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-dc_topic_0055025333__p38273810145352">Specifies the ID of the remote endpoint group that records the tenant CIDR blocks.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row53944047145352"><td class="cellrowborder" valign="top" width="29.590000000000003%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-dc_topic_0055025333__p51429535145352">service_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.35%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-dc_topic_0055025333__p5042777145352">String</p>
</td>
<td class="cellrowborder" valign="top" width="19.09%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-dc_topic_0055025333__p5811775145352">No</p>
</td>
<td class="cellrowborder" valign="top" width="30.970000000000002%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-dc_topic_0055025333__p991803145352">Specifies the ID of the service endpoint group that records the public service CIDR blocks.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row27476943164116"><td class="cellrowborder" valign="top" width="29.590000000000003%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-dc_topic_0055025333__p45959087164119">rate_limit</p>
</td>
<td class="cellrowborder" valign="top" width="20.35%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-dc_topic_0055025333__p31698555164119">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="19.09%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-dc_topic_0055025333__p17446123164119">No</p>
</td>
<td class="cellrowborder" valign="top" width="30.970000000000002%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-dc_topic_0055025333__p3849831164119">Specifies whether to limit the traffic rate. The value can be <strong id="en-dc_topic_0055025333__b15280145145111">true</strong> or <strong id="en-dc_topic_0055025333__b11281185118517">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025333__section33278910143924"><h4 class="sectiontitle">Response</h4><p id="en-dc_topic_0055025333__p2714668115724"><a href="#en-dc_topic_0055025333__table2216502815556">Table 4</a> lists the response parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025333__table2216502815556"></a><a name="table2216502815556"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025333__table2216502815556" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameter</caption><thead align="left"><tr id="en-dc_topic_0055025333__row2118154015556"><th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.4.3.2.4.1.1"><p id="en-dc_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-dc_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-dc_topic_0055025333__p2825222315556">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025333__row672873115556"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-dc_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-dc_topic_0055025333__p5668342815556">Dictionary data structure</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-dc_topic_0055025333__p4976072015556">Specifies the <strong id="en-dc_topic_0055025333__b842352706194240">virtual_interface</strong> object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025333__table12493326143924" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Description of field <strong id="en-dc_topic_0055025333__b178621927414">virtual_interface</strong></caption><thead align="left"><tr id="en-dc_topic_0055025333__row6524313143924"><th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.4.4.2.4.1.1"><p id="en-dc_topic_0055025333__p58396671143924">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.4.2.4.1.2"><p id="en-dc_topic_0055025333__p7441546143924">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.4.2.4.1.3"><p id="en-dc_topic_0055025333__p55439607143924">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025333__row40598305145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p46868244145335">id</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p38231421145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p50534474145335">Specifies the virtual interface ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row41793625145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p63974246145335">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p14531420145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p46065903145335">Specifies the project ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row64296059145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p27611835145335">name</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p21966137145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p37094374145335">Specifies the virtual interface name.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row36970168145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p64035604145335">description</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p19501411145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p39265055145335">Provides supplementary information about the virtual interface.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row33933958145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p35849146145335">direct_connect_id</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p18099700145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p36556115145335">Specifies the connection ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row11226980145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p7188862145335">vgw_ id</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p45426958145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p15808067145335">Specifies the virtual gateway ID.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row53443225145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p48465145145335">type</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p33362712145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p50753784145335">Specifies the virtual interface type. The value can be <strong id="en-dc_topic_0055025333__b842352706142157">public</strong> or <strong id="en-dc_topic_0055025333__b84235270614220">private</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row13394676145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p22524621145335">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p12555013145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p30868483145335">Specifies the access service type. The value can be <strong id="en-dc_topic_0055025333__b1650500527142036">vpc</strong>, <strong id="en-dc_topic_0055025333__b26378606142036">public service</strong>, or <strong id="en-dc_topic_0055025333__b1032837367142036">vpc and public service</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row61140620145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p21655010145335">vlan</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p15690831212825">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p62484413145335">Specifies the VLAN used by the local gateway to communicate with the remote gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row58989185145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p51327912145335">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p5156695419451">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p17413768145335">Specifies the virtual interface bandwidth.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row58750137145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p11061850145335">local_gateway_v4_ip</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p23594682145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p51672844145335">Specifies the IPv4 address of the local gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row36353954145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p21430584145335">remote_gateway_v4_ip</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p58155769145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p46114937145335">Specifies the IPv4 address of the remote gateway.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row26408949145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p63357643145335">route_mode</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p31695496145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p50890954145335">Specifies the routing mode. The value can be <strong id="en-dc_topic_0055025333__b84235270614653">static</strong> or <strong id="en-dc_topic_0055025333__b84235270614655">bgp</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row17847408145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p55413029145335">bgp_asn</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p59270342145335">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p43961599145335">Specifies the AS number of the BGP peer.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row24352666145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p37078045145335">bgp_md5</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p50531678145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p20554593145335">Specifies the MD5 password of the BGP peer.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row54901634145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p19022230145335">remote_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p64405632145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p47945666145335">Specifies the ID of the remote endpoint group that records the tenant CIDRs.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row50839424145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p55781303145335">service_ep_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p21991717145335">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p3598777145335">Specifies the ID of the service endpoint group that records the public service CIDR blocks.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row41472724161653"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p14881030161656">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p52974842161656">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p47576540161656">Specifies the time when the virtual interface is created.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row27939490171634"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p50962070171640">delete_time</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p34287015171640">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p8196682171640">Specifies the time when the virtual interface is deleted.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row4406922419459"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p632259461952">status</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p210279641952">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p1999411815217">Specifies the virtual interface status.</p>
<p id="en-dc_topic_0055025333__p557608071952">The value can be <strong id="en-dc_topic_0055025333__b84235270617169">ACTIVE</strong>, <strong id="en-dc_topic_0055025333__b842352706171613">DOWN</strong>, <strong id="en-dc_topic_0055025333__b842352706171618">BUILD</strong>, <strong id="en-dc_topic_0055025333__b842352706171622">ERROR</strong>, <strong id="en-dc_topic_0055025333__b842352706171626">PENDING_CREATE</strong>, <strong id="en-dc_topic_0055025333__b842352706171630">PENDING_UPDATE</strong>, <strong id="en-dc_topic_0055025333__b842352706171633">PENDING_DELETE</strong>, <strong id="en-dc_topic_0055025333__b255042327233226">DELETED</strong>, <strong id="en-dc_topic_0055025333__b901715572233226">AUTHORIZATION</strong>, or <strong id="en-dc_topic_0055025333__b1624075844233226">REJECTED</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row20561905145335"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p6263091145335">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p37548366145335">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p2320543515223">Specifies the administrative status of the virtual interface.</p>
<p id="en-dc_topic_0055025333__p65299689145335">The value can be <strong id="en-dc_topic_0055025333__b842352706154840">true</strong> or <strong id="en-dc_topic_0055025333__b842352706154844">false</strong>.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025333__row13946133405114"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-dc_topic_0055025333__p6570194316514">rate_limit</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-dc_topic_0055025333__p1357015439512">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-dc_topic_0055025333__p15708434514">Specifies whether to limit the traffic rate. The value can be <strong id="en-dc_topic_0055025333__b15457452105112">true</strong> or <strong id="en-dc_topic_0055025333__b04572052185115">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025333__section9931099143924"><h4 class="sectiontitle">Examples</h4><ul id="en-dc_topic_0055025333__ul19574201521411"><li id="en-dc_topic_0055025333__li257441501420">Example request<pre class="screen" id="en-dc_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-dc_topic_0055025333__ul2072310282147"><li id="en-dc_topic_0055025333__li57231428151411">Example response<pre class="screen" id="en-dc_topic_0055025333__screen55871140151413">{
"virtual_interface" : {
"id" : "67c59cf4-1a64-46c7-763f-22eb1b9e8986",
"tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
"name" : "virtual interface1",
"description" : "New description",
"direct_connect_id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
"vgw_id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",
"type" : "private",
"service_type" : "vpc",
"vlan" : 100,
"bandwidth" : 10,
"local_gateway_v4_ip" : "180.1.1.1/24",
"remote_gateway_v4_ip" : "180.1.1.2/24",
"route_mode" : "static",
"remote_ep_group_id" : "78e34cf1-5468-87c7-223d-56e78b9699ef"
}
}</pre>
</li></ul>
<div class="section" id="en-dc_topic_0055025333__section38874431173428"><h4 class="sectiontitle">Returned Value</h4><p id="en-dc_topic_0055025333__p176816317298">For details, see section <a href="en-dc_topic_0055025342.html">Common Returned Values</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-dc_topic_0055025327.html">Virtual Interface</a></div>
</div>
</div>
View Git Blame Copy Permalink