vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpc/api-ref/vpc_router_0004.html
Qin Ying, Fan 310d2d9eb1 VPC API 20230106 version 
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>
2024-02-06 08:38:37 +00:00

353 lines
28 KiB
HTML
Raw Blame History

<a name="vpc_router_0004"></a><a name="vpc_router_0004"></a>
<h1 class="topictitle1">Updating a Router</h1>
<div id="body1495543735581"><div class="section" id="vpc_router_0004__section2668865720589"><h4 class="sectiontitle">Function</h4><p id="vpc_router_0004__p1429757020589">This API is used to update a router.</p>
</div>
<div class="section" id="vpc_router_0004__section6156926920589"><h4 class="sectiontitle">URI</h4><p id="vpc_router_0004__p960653173818">PUT /v2.0/routers/{router_id}</p>
</div>
<div class="section" id="vpc_router_0004__section3272152320589"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0004__table3319773520589" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="vpc_router_0004__row680247320589"><th align="left" class="cellrowborder" valign="top" width="14.44%" id="mcps1.3.3.2.2.5.1.1"><p id="vpc_router_0004__p1412942020589"><strong id="vpc_router_0004__b1873082515612">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.5%" id="mcps1.3.3.2.2.5.1.2"><p id="vpc_router_0004__p2578437120589"><strong id="vpc_router_0004__b1357123205610">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.36%" id="mcps1.3.3.2.2.5.1.3"><p id="vpc_router_0004__p363234320589"><strong id="vpc_router_0004__b15446102820561">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.7%" id="mcps1.3.3.2.2.5.1.4"><p id="vpc_router_0004__p815930320589"><strong id="vpc_router_0004__b1280203035618">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0004__row5692383620589"><td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.1 "><p id="vpc_router_0004__p4742802620589">router</p>
</td>
<td class="cellrowborder" valign="top" width="13.5%" headers="mcps1.3.3.2.2.5.1.2 "><p id="vpc_router_0004__p5858622220589">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10.36%" headers="mcps1.3.3.2.2.5.1.3 "><p id="vpc_router_0004__p1646487220589"><a href="#vpc_router_0004__table128801154104715">router</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="61.7%" headers="mcps1.3.3.2.2.5.1.4 "><p id="vpc_router_0004__p63022381205744">Specifies the router. For details, see <a href="#vpc_router_0004__table128801154104715">Table 2</a>.</p>
<p id="vpc_router_0004__p2811868820589">You must specify at least one attribute when updating a router.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_router_0004__table128801154104715"></a><a name="table128801154104715"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0004__table128801154104715" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="vpc_router_0004__b53240596558">router</strong> objects</caption><thead align="left"><tr id="vpc_router_0004__row138801854134716"><th align="left" class="cellrowborder" valign="top" width="23.54%" id="mcps1.3.3.3.2.5.1.1"><p id="vpc_router_0004__p20880145424714"><strong id="vpc_router_0004__b1260154712588">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.72%" id="mcps1.3.3.3.2.5.1.2"><p id="vpc_router_0004__p981918394815"><strong id="vpc_router_0004__b460317035914">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.599999999999998%" id="mcps1.3.3.3.2.5.1.3"><p id="vpc_router_0004__p5881754124714"><strong id="vpc_router_0004__b123731816596">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.14%" id="mcps1.3.3.3.2.5.1.4"><p id="vpc_router_0004__p10881175424718"><strong id="vpc_router_0004__b31621322596">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0004__row118821154134714"><td class="cellrowborder" valign="top" width="23.54%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_router_0004__p288212543477">name</p>
</td>
<td class="cellrowborder" valign="top" width="11.72%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_router_0004__p1881923164818">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.599999999999998%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_router_0004__p588205464712">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.14%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_router_0004__p98821554104719">Specifies the router name.</p>
<p id="vpc_router_0004__p133126255124">Instructions:</p>
<p id="vpc_router_0004__p5882354114711">The name can contain only letters, digits, underscores (_), hyphens (-), and periods (.).</p>
</td>
</tr>
<tr id="vpc_router_0004__row68821454104717"><td class="cellrowborder" valign="top" width="23.54%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_router_0004__p2882155464710">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="11.72%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_router_0004__p9819193104813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.599999999999998%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_router_0004__p288265464716">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="44.14%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_router_0004__p19882175411474">Specifies the administrative status.</p>
<p id="vpc_router_0004__p48828543474">The value can only be <strong id="vpc_router_0004__b20922162125912">true</strong>.</p>
</td>
</tr>
<tr id="vpc_router_0004__row17883115417475"><td class="cellrowborder" valign="top" width="23.54%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_router_0004__p12883175494713">external_gateway_info</p>
</td>
<td class="cellrowborder" valign="top" width="11.72%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_router_0004__p1281914344820">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.599999999999998%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_router_0004__p128831054134710"><a href="#vpc_router_0004__table189345484710">external_gateway_info</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="44.14%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_router_0004__p6883115404715">Specifies the external gateway. This is an extended attribute. For details, see the <strong id="vpc_router_0004__b13739624207">external_gateway_info</strong> objects.</p>
</td>
</tr>
<tr id="vpc_router_0004__row14883145434716"><td class="cellrowborder" valign="top" width="23.54%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_router_0004__p14883195410473">routes</p>
</td>
<td class="cellrowborder" valign="top" width="11.72%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_router_0004__p12819143204816">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.599999999999998%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_router_0004__p12541618133215">Array of <a href="#vpc_router_0004__table5893155464718">route</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="44.14%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_router_0004__p10884125412477">Specifies a route list. This is an extended attribute. For details, see <a href="#vpc_router_0004__table5893155464718">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_router_0004__table189345484710"></a><a name="table189345484710"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0004__table189345484710" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_router_0004__b646474016018">external_gateway_info</strong> objects</caption><thead align="left"><tr id="vpc_router_0004__row1989315411471"><th align="left" class="cellrowborder" valign="top" width="19.21192119211921%" id="mcps1.3.3.4.2.5.1.1"><p id="vpc_router_0004__p8893654144716"><strong id="vpc_router_0004__b1740664117012">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.04180418041804%" id="mcps1.3.3.4.2.5.1.2"><p id="vpc_router_0004__p9914193519213"><strong id="vpc_router_0004__b168870421205">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.51165116511651%" id="mcps1.3.3.4.2.5.1.3"><p id="vpc_router_0004__p0893154164719"><strong id="vpc_router_0004__b1213818468018">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.23462346234623%" id="mcps1.3.3.4.2.5.1.4"><p id="vpc_router_0004__p3893135414472"><strong id="vpc_router_0004__b4688104611013">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0004__row19893154184710"><td class="cellrowborder" valign="top" width="19.21192119211921%" headers="mcps1.3.3.4.2.5.1.1 "><p id="vpc_router_0004__p1289385414477">network_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.04180418041804%" headers="mcps1.3.3.4.2.5.1.2 "><p id="vpc_router_0004__p1891463572117">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.51165116511651%" headers="mcps1.3.3.4.2.5.1.3 "><p id="vpc_router_0004__p16893654154714">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.23462346234623%" headers="mcps1.3.3.4.2.5.1.4 "><p id="vpc_router_0004__p15893135454716">Specifies the UUID of the external network.</p>
<p id="vpc_router_0004__p3893105412472">You can use <strong id="vpc_router_0004__b1285355418010">GET /v2.0/networks?router:external=True</strong> or run the <strong id="vpc_router_0004__b148551541105">neutron net-external-list</strong> command to query information about the external network.</p>
</td>
</tr>
<tr id="vpc_router_0004__row1689395415476"><td class="cellrowborder" valign="top" width="19.21192119211921%" headers="mcps1.3.3.4.2.5.1.1 "><p id="vpc_router_0004__p2893185414475">enable_snat</p>
</td>
<td class="cellrowborder" valign="top" width="18.04180418041804%" headers="mcps1.3.3.4.2.5.1.2 "><p id="vpc_router_0004__p1891414355218">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.51165116511651%" headers="mcps1.3.3.4.2.5.1.3 "><p id="vpc_router_0004__p168931154164710">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="46.23462346234623%" headers="mcps1.3.3.4.2.5.1.4 "><p id="vpc_router_0004__p88931354164710">Specifies whether the SNAT function is enabled.</p>
<p id="vpc_router_0004__p1889316541471">The default value is <strong id="vpc_router_0004__b024415341014">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_router_0004__table5893155464718"></a><a name="table5893155464718"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0004__table5893155464718" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_router_0004__b814711358115">route</strong> objects</caption><thead align="left"><tr id="vpc_router_0004__row989335411471"><th align="left" class="cellrowborder" valign="top" width="19.321932193219325%" id="mcps1.3.3.5.2.5.1.1"><p id="vpc_router_0004__p0894105494711"><strong id="vpc_router_0004__b14424153612114">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.931793179317932%" id="mcps1.3.3.5.2.5.1.2"><p id="vpc_router_0004__p1963454216214"><strong id="vpc_router_0004__b57491137816">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.51165116511651%" id="mcps1.3.3.5.2.5.1.3"><p id="vpc_router_0004__p38941548472"><strong id="vpc_router_0004__b145700381413">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.23462346234623%" id="mcps1.3.3.5.2.5.1.4"><p id="vpc_router_0004__p789445444713"><strong id="vpc_router_0004__b934416391410">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0004__row1589455404711"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.3.5.2.5.1.1 "><p id="vpc_router_0004__p7894185418479">destination</p>
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.3.5.2.5.1.2 "><p id="vpc_router_0004__p14634164217211">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.51165116511651%" headers="mcps1.3.3.5.2.5.1.3 "><p id="vpc_router_0004__p118941554144712">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.23462346234623%" headers="mcps1.3.3.5.2.5.1.4 "><p id="vpc_router_0004__p689515415471">Specifies the IP address range.</p>
<p id="vpc_router_0004__p15350341121316">Instructions:</p>
<p id="vpc_router_0004__p634312501138">The prefix cannot be the same as that of a direct route.</p>
</td>
</tr>
<tr id="vpc_router_0004__row20895175444713"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.3.5.2.5.1.1 "><p id="vpc_router_0004__p1889515444716">nexthop</p>
</td>
<td class="cellrowborder" valign="top" width="17.931793179317932%" headers="mcps1.3.3.5.2.5.1.2 "><p id="vpc_router_0004__p13634142202117">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.51165116511651%" headers="mcps1.3.3.5.2.5.1.3 "><p id="vpc_router_0004__p208951854184713">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.23462346234623%" headers="mcps1.3.3.5.2.5.1.4 "><p id="vpc_router_0004__p12895654184714">Specifies the next hop IP address. The IP address can only be one in the subnet associated with the router.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_router_0004__section1233210374315"><h4 class="sectiontitle">Example Request</h4><p id="vpc_router_0004__p1091319394237">Change the name of the router whose ID is f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 to <strong id="vpc_router_0004__b1792113516115">router-220</strong>.</p>
<pre class="screen" id="vpc_router_0004__screen205874556316">PUT https://{Endpoint}/v2.0/routers/f5dbdfe0-86f9-4b0a-9a32-6be143f0a076
{
"router": {
"name": "router-220"
}
}</pre>
</div>
<div class="section" id="vpc_router_0004__section6302125920589"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0004__table444833020589" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameter</caption><thead align="left"><tr id="vpc_router_0004__row3190269720589"><th align="left" class="cellrowborder" valign="top" width="15.73%" id="mcps1.3.5.2.2.4.1.1"><p id="vpc_router_0004__p3398165120589">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="8.99%" id="mcps1.3.5.2.2.4.1.2"><p id="vpc_router_0004__p105036620589">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="75.28%" id="mcps1.3.5.2.2.4.1.3"><p id="vpc_router_0004__p4635141320589">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0004__row6347701020589"><td class="cellrowborder" valign="top" width="15.73%" headers="mcps1.3.5.2.2.4.1.1 "><p id="vpc_router_0004__p4136417520589">router</p>
</td>
<td class="cellrowborder" valign="top" width="8.99%" headers="mcps1.3.5.2.2.4.1.2 "><p id="vpc_router_0004__p6216386020589"><a href="#vpc_router_0004__table24153696181443">router</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="75.28%" headers="mcps1.3.5.2.2.4.1.3 "><p id="vpc_router_0004__p3652335220589">Specifies the router. For details, see <a href="#vpc_router_0004__table24153696181443">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_router_0004__table24153696181443"></a><a name="table24153696181443"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0004__table24153696181443" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="vpc_router_0004__b7822913925">router</strong> objects</caption><thead align="left"><tr id="vpc_router_0004__row11861342181443"><th align="left" class="cellrowborder" valign="top" width="26.669999999999998%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_router_0004__p21244677181443"><strong id="vpc_router_0004__b239191519211">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.330000000000002%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_router_0004__p43097239181443"><strong id="vpc_router_0004__b22156166218">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_router_0004__p36728767181443"><strong id="vpc_router_0004__b1687710161027">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0004__row22240136181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_router_0004__p56620590181443">id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_router_0004__p22865048181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_router_0004__p46905229181443">Specifies the router ID.</p>
<p id="vpc_router_0004__p121142486504">This parameter is not mandatory when you query routers.</p>
</td>
</tr>
<tr id="vpc_router_0004__row19493885181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_router_0004__p35500827181443">name</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_router_0004__p56994705181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_router_0004__p11978624181443">Specifies the router name.</p>
<p id="vpc_router_0004__p30744457181443">The name can contain only letters, digits, underscores (_), hyphens (-), and periods (.).</p>
</td>
</tr>
<tr id="vpc_router_0004__row8264657181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_router_0004__p65457453181443">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_router_0004__p453502181443">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_router_0004__p48641520181443">Specifies the administrative status.</p>
<p id="vpc_router_0004__p35120501181443">The value can only be <strong id="vpc_router_0004__b073217511625">true</strong>.</p>
</td>
</tr>
<tr id="vpc_router_0004__row47649056181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_router_0004__p34368308181443">status</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_router_0004__p32369557181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_router_0004__p4016564181443">Specifies the router status. The value can be <strong id="vpc_router_0004__b934555926">ACTIVE</strong>, <strong id="vpc_router_0004__b193615558215">DOWN</strong>, or <strong id="vpc_router_0004__b53818559218">ERROR</strong>.</p>
</td>
</tr>
<tr id="vpc_router_0004__row36149082181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_router_0004__p42394506181443">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_router_0004__p11402971181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_router_0004__p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_router_0004__row26765861181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_router_0004__p20551115181443">external_gateway_info</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_router_0004__p54027655181443"><a href="#vpc_router_0004__table11448068181443">external_gateway_info</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_router_0004__p12911840181443">Specifies the external gateway. This is an extended attribute. For details, see the <strong id="vpc_router_0004__b169971641318">external_gateway_info</strong> objects.</p>
</td>
</tr>
<tr id="vpc_router_0004__row49097702181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_router_0004__p17490925181443">routes</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_router_0004__p7478812181443">Array of <a href="#vpc_router_0004__table18829650181443">route</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_router_0004__p5122123194853">Specifies a route list. This is an extended attribute. For details, see <a href="#vpc_router_0004__table18829650181443">Table 8</a>.</p>
</td>
</tr>
<tr id="vpc_router_0004__row7278189151614"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_router_0004__p870051413911">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_router_0004__p15700614790">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_router_0004__p0236436142611">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_router_0004__row172292215166"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_router_0004__p1953114119914">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_router_0004__p595318416919">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_router_0004__p1395374115919">Specifies the time (UTC) when the router is created.</p>
<p id="vpc_router_0004__p65980291419">Format: <em id="vpc_router_0004__i11531202913314">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
<tr id="vpc_router_0004__row106341917161611"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_router_0004__p139719548912">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_router_0004__p53971154594">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_router_0004__p1339713549918">Specifies the time (UTC) when the router is updated.</p>
<p id="vpc_router_0004__p73282255586">Format: <em id="vpc_router_0004__i52401346310">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_router_0004__table11448068181443"></a><a name="table11448068181443"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0004__table11448068181443" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="vpc_router_0004__b19204335734">external_gateway_info</strong> objects</caption><thead align="left"><tr id="vpc_router_0004__row58732356181443"><th align="left" class="cellrowborder" valign="top" width="26.669999999999998%" id="mcps1.3.5.4.2.4.1.1"><p id="vpc_router_0004__p59700400181443"><strong id="vpc_router_0004__b793610491739">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.34%" id="mcps1.3.5.4.2.4.1.2"><p id="vpc_router_0004__p3894228181443"><strong id="vpc_router_0004__b98107507320">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.99%" id="mcps1.3.5.4.2.4.1.3"><p id="vpc_router_0004__p1781307181443"><strong id="vpc_router_0004__b125428511339">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0004__row10068178181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_router_0004__p10216081181443">network_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.34%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_router_0004__p22196257181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_router_0004__p38375206181443">Specifies the UUID of the external network.</p>
<p id="vpc_router_0004__p21383968181443">You can use <strong id="vpc_router_0004__b1717718551933">GET /v2.0/networks?router:external=True</strong> or run the <strong id="vpc_router_0004__b111801551432">neutron net-external-list</strong> command to query information about the external network.</p>
</td>
</tr>
<tr id="vpc_router_0004__row58237990181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_router_0004__p19656760181443">enable_snat</p>
</td>
<td class="cellrowborder" valign="top" width="23.34%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_router_0004__p48693751181443">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_router_0004__p22976335181443">Specifies whether the SNAT function is enabled.</p>
<p id="vpc_router_0004__p49143812181443">The default value is <strong id="vpc_router_0004__b173411501248">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_router_0004__table18829650181443"></a><a name="table18829650181443"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0004__table18829650181443" frame="border" border="1" rules="all"><caption><b>Table 8 </b><strong id="vpc_router_0004__b1118318118414">route</strong> objects</caption><thead align="left"><tr id="vpc_router_0004__row60542282181443"><th align="left" class="cellrowborder" valign="top" width="26.669999999999998%" id="mcps1.3.5.5.2.4.1.1"><p id="vpc_router_0004__p4977811181443"><strong id="vpc_router_0004__b14963210415">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.34%" id="mcps1.3.5.5.2.4.1.2"><p id="vpc_router_0004__p549581181443"><strong id="vpc_router_0004__b137375315420">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.99%" id="mcps1.3.5.5.2.4.1.3"><p id="vpc_router_0004__p9206714181443"><strong id="vpc_router_0004__b177769415419">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0004__row7546366181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.5.2.4.1.1 "><p id="vpc_router_0004__p7275939181443">destination</p>
</td>
<td class="cellrowborder" valign="top" width="23.34%" headers="mcps1.3.5.5.2.4.1.2 "><p id="vpc_router_0004__p52480209181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.5.5.2.4.1.3 "><p id="vpc_router_0004__p66892155181443">Specifies the IP address range.</p>
</td>
</tr>
<tr id="vpc_router_0004__row65158490181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.5.5.2.4.1.1 "><p id="vpc_router_0004__p43346313181443">nexthop</p>
</td>
<td class="cellrowborder" valign="top" width="23.34%" headers="mcps1.3.5.5.2.4.1.2 "><p id="vpc_router_0004__p21390453181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.5.5.2.4.1.3 "><p id="vpc_router_0004__p17763616181443">Specifies the next hop IP address. The IP address can only be one in the subnet associated with the router.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_router_0004__section6027472020589"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="vpc_router_0004__screen147291761413">{
"router": {
"id": "f5dbdfe0-86f9-4b0a-9a32-6be143f0a076",
"name": "router-220",
"status": "ACTIVE",
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"admin_state_up": true,
"external_gateway_info": {
"network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
"enable_snat": false
},
"routes": [],
"created_at": "2018-09-20T02:06:07",
"updated_at": "2018-09-20T02:06:09"
}
}</pre>
</div>
<div class="section" id="vpc_router_0004__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_router_0004__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="vpc_router_0004__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_router_0004__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>
View Git Blame Copy Permalink