doc-exports/docs/vpc/api-ref/vpc_router_0007.html
gtema 4cfecba474 VPC api from PR#278
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-10-17 12:39:05 +00:00

116 lines
8.3 KiB
HTML

<a name="vpc_router_0007"></a><a name="vpc_router_0007"></a>
<h1 class="topictitle1">Removing an Interface from a Router</h1>
<div id="body1495543735581"><div class="section" id="vpc_router_0007__section30197552205849"><h4 class="sectiontitle">Function</h4><p id="vpc_router_0007__p30082676205849">Removing an interface from a router will also remove the port.</p>
<p id="vpc_router_0007__p3133183984514">Restrictions</p>
<p id="vpc_router_0007__p2049184518453">You are not allowed to remove an interface from a router if there are load balancers in the subnet.</p>
</div>
<div class="section" id="vpc_router_0007__section2308632205849"><h4 class="sectiontitle">URI</h4><p id="vpc_router_0007__p783419434512">PUT /v2.0/routers/{router_id}/remove_router_interface</p>
</div>
<div class="section" id="vpc_router_0007__section55215913205849"><h4 class="sectiontitle">Request Message</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0007__table43303993205849" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="vpc_router_0007__row15734591205849"><th align="left" class="cellrowborder" valign="top" width="18.099999999999998%" id="mcps1.3.3.2.2.5.1.1"><p id="vpc_router_0007__p66542384205849">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.54%" id="mcps1.3.3.2.2.5.1.2"><p id="vpc_router_0007__p21224062205849">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.09%" id="mcps1.3.3.2.2.5.1.3"><p id="vpc_router_0007__p41427472205849">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.27%" id="mcps1.3.3.2.2.5.1.4"><p id="vpc_router_0007__p182095205849">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0007__row14749730205849"><td class="cellrowborder" valign="top" width="18.099999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="vpc_router_0007__p53877490205849">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.54%" headers="mcps1.3.3.2.2.5.1.2 "><p id="vpc_router_0007__p2000550205849">String</p>
</td>
<td class="cellrowborder" valign="top" width="18.09%" headers="mcps1.3.3.2.2.5.1.3 "><p id="vpc_router_0007__p27826855205849">No</p>
</td>
<td class="cellrowborder" valign="top" width="50.27%" headers="mcps1.3.3.2.2.5.1.4 "><p id="vpc_router_0007__p39382748205849">Specifies the subnet ID. Either <strong id="vpc_router_0007__b3115262052">subnet_id</strong> or <strong id="vpc_router_0007__b91215269520">port_id</strong> must be specified.</p>
<p id="vpc_router_0007__p18900413205849">Use the gateway IP address of the subnet to create a router interface.</p>
</td>
</tr>
<tr id="vpc_router_0007__row35885997205849"><td class="cellrowborder" valign="top" width="18.099999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="vpc_router_0007__p21084676205849">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.54%" headers="mcps1.3.3.2.2.5.1.2 "><p id="vpc_router_0007__p30137158205849">String</p>
</td>
<td class="cellrowborder" valign="top" width="18.09%" headers="mcps1.3.3.2.2.5.1.3 "><p id="vpc_router_0007__p25190749205849">No</p>
</td>
<td class="cellrowborder" valign="top" width="50.27%" headers="mcps1.3.3.2.2.5.1.4 "><p id="vpc_router_0007__p27184817205849">Specifies the port ID. Either <strong id="vpc_router_0007__b1556928203191732">subnet_id</strong> or <strong id="vpc_router_0007__b2095602666191732">port_id</strong> is used. Use the port IP address to create a router interface.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_router_0007__section43336765205849"><h4 class="sectiontitle">Response Message</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0007__table20617078205849" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_router_0007__row10859799205849"><th align="left" class="cellrowborder" valign="top" width="19.32%" id="mcps1.3.4.2.2.4.1.1"><p id="vpc_router_0007__p7228509205849">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.909999999999998%" id="mcps1.3.4.2.2.4.1.2"><p id="vpc_router_0007__p48638393205849">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.77000000000001%" id="mcps1.3.4.2.2.4.1.3"><p id="vpc_router_0007__p13848780205849">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0007__row48009429205849"><td class="cellrowborder" valign="top" width="19.32%" headers="mcps1.3.4.2.2.4.1.1 "><p id="vpc_router_0007__p63558546205849">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.909999999999998%" headers="mcps1.3.4.2.2.4.1.2 "><p id="vpc_router_0007__p47968620205849">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.77000000000001%" headers="mcps1.3.4.2.2.4.1.3 "><p id="vpc_router_0007__p48654997205849">Specifies the subnet ID.</p>
</td>
</tr>
<tr id="vpc_router_0007__row35241790205849"><td class="cellrowborder" valign="top" width="19.32%" headers="mcps1.3.4.2.2.4.1.1 "><p id="vpc_router_0007__p36012759205849">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.909999999999998%" headers="mcps1.3.4.2.2.4.1.2 "><p id="vpc_router_0007__p31352336205849">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.77000000000001%" headers="mcps1.3.4.2.2.4.1.3 "><p id="vpc_router_0007__p10487112">Specifies the project ID.</p>
</td>
</tr>
<tr id="vpc_router_0007__row157911111104914"><td class="cellrowborder" valign="top" width="19.32%" headers="mcps1.3.4.2.2.4.1.1 "><p id="vpc_router_0007__p3602101115481">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.909999999999998%" headers="mcps1.3.4.2.2.4.1.2 "><p id="vpc_router_0007__p19598203374820">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.77000000000001%" headers="mcps1.3.4.2.2.4.1.3 "><p id="vpc_router_0007__p165981433194815">Specifies the project ID.</p>
</td>
</tr>
<tr id="vpc_router_0007__row58967197205849"><td class="cellrowborder" valign="top" width="19.32%" headers="mcps1.3.4.2.2.4.1.1 "><p id="vpc_router_0007__p11613691205849">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.909999999999998%" headers="mcps1.3.4.2.2.4.1.2 "><p id="vpc_router_0007__p1184925205849">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.77000000000001%" headers="mcps1.3.4.2.2.4.1.3 "><p id="vpc_router_0007__p56778703205849">Specifies the port ID.</p>
</td>
</tr>
<tr id="vpc_router_0007__row41246284205849"><td class="cellrowborder" valign="top" width="19.32%" headers="mcps1.3.4.2.2.4.1.1 "><p id="vpc_router_0007__p52614697205849">id</p>
</td>
<td class="cellrowborder" valign="top" width="15.909999999999998%" headers="mcps1.3.4.2.2.4.1.2 "><p id="vpc_router_0007__p33932046205849">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.77000000000001%" headers="mcps1.3.4.2.2.4.1.3 "><p id="vpc_router_0007__p28056338205849">Specifies the router ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_router_0007__section51180458205849"><h4 class="sectiontitle">Example:</h4><p id="vpc_router_0007__p1163217328464">Example request</p>
<pre class="screen" id="vpc_router_0007__screen51976465205849">PUT https://{Endpoint}/v2.0/routers/b625c58c-0cfe-49e0-acc8-f2374f8187ff/remove_router_interface
{"subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e"}</pre>
</div>
<p id="vpc_router_0007__p0176194513465">Example response</p>
<pre class="screen" id="vpc_router_0007__screen37449098205849">{
"subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e",
"tenant_id": "3d72597871904daeb6887f75f848b531",
"project_id": "3d72597871904daeb6887f75f848b531",
"port_id": "34d7d063-8f40-4958-b420-096db40d4067",
"id": "b625c58c-0cfe-49e0-acc8-f2374f8187ff"
}</pre>
<div class="section" id="vpc_router_0007__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_router_0007__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="vpc_router_0007__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_router_0007__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_router_0000.html">Router</a></div>
</div>
</div>