vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpc/api-ref/vpc_router_0001.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

331 lines
28 KiB
HTML
Raw Blame History

<a name="vpc_router_0001"></a><a name="vpc_router_0001"></a>
<h1 class="topictitle1">Querying Routers</h1>
<div id="body1496910549540"><div class="section" id="vpc_router_0001__section55573059205730"><h4 class="sectiontitle">Function</h4><p id="vpc_router_0001__p106761613102414">This API is used to query all routers accessible to the tenant submitting the request. </p>
</div>
<div class="section" id="vpc_router_0001__section46115681205730"><h4 class="sectiontitle">URI</h4><p id="vpc_router_0001__p9467143612314">GET /v2.0/routers</p>
<p id="vpc_router_0001__p158521718174110">Example:</p>
<pre class="screen" id="vpc_router_0001__screen13852818124119">GET https://{Endpoint}/v2.0/routers?id={id}&amp;name={name}&amp;admin_state_up={admin_state_up}&amp;tenant_id={tenant_id}&amp;status={status}</pre>
<p id="vpc_router_0001__p1144143055512">Example of querying routers by page</p>
<pre class="screen" id="vpc_router_0001__screen6349039695144">GET https://{Endpoint}/v2.0/routers?limit=2&amp;marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe&amp;page_reverse=False</pre>
</div>
<p id="vpc_router_0001__p9783514181712"><a href="#vpc_router_0001__table966161441716">Table 1</a> describes the parameters.</p>
<div class="tablenoborder"><a name="vpc_router_0001__table966161441716"></a><a name="table966161441716"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0001__table966161441716" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_router_0001__row57831214171715"><th align="left" class="cellrowborder" valign="top" width="22.222222222222225%" id="mcps1.3.4.2.5.1.1"><p id="vpc_router_0001__p1478361451716"><strong id="vpc_router_0001__b156013111152">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.91129112911291%" id="mcps1.3.4.2.5.1.2"><p id="vpc_router_0001__p57832145174"><strong id="vpc_router_0001__b6828131410513">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.211321132113211%" id="mcps1.3.4.2.5.1.3"><p id="vpc_router_0001__p167831314131711"><strong id="vpc_router_0001__b107808151453">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.65516551655165%" id="mcps1.3.4.2.5.1.4"><p id="vpc_router_0001__p137831144177"><strong id="vpc_router_0001__b132837171353">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0001__row1078441451720"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_router_0001__p1778416144170">id</p>
</td>
<td class="cellrowborder" valign="top" width="12.91129112911291%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_router_0001__p67842143178">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113211%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_router_0001__p15784191431717">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.65516551655165%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_router_0001__p1478441481719">Specifies that the router ID is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_router_0001__row14784101461711"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_router_0001__p207841314171712">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="12.91129112911291%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_router_0001__p107841014181716">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113211%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_router_0001__p878418146174">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="51.65516551655165%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_router_0001__p1476743711713">Specifies that the admin state is used as the filtering condition.</p>
<p id="vpc_router_0001__p1078421441710">The value can be <strong id="vpc_router_0001__b45964291519">true</strong> or <strong id="vpc_router_0001__b125961629055">false</strong>.</p>
</td>
</tr>
<tr id="vpc_router_0001__row078411140178"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_router_0001__p187841514141717">status</p>
</td>
<td class="cellrowborder" valign="top" width="12.91129112911291%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_router_0001__p1578417147173">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113211%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_router_0001__p10784151415173">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.65516551655165%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_router_0001__p16910184011710">Specifies that the router status is used as the filtering condition.</p>
<p id="vpc_router_0001__p478431431718">The value can be <strong id="vpc_router_0001__b18546440858">ACTIVE</strong>, <strong id="vpc_router_0001__b195691114612">DOWN</strong>, or <strong id="vpc_router_0001__b154616401456">ERROE</strong>.</p>
</td>
</tr>
<tr id="vpc_router_0001__row87841014181710"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_router_0001__p37841149177">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.91129112911291%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_router_0001__p13784151421713">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113211%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_router_0001__p12784161411177">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.65516551655165%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_router_0001__p6784131461718">Specifies that the project ID is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_router_0001__row37841314121714"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_router_0001__p14784191491715">marker</p>
</td>
<td class="cellrowborder" valign="top" width="12.91129112911291%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_router_0001__p8784141471714">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113211%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_router_0001__p13784161412171">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.65516551655165%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_router_0001__p28526205175853">Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.</p>
<p id="vpc_router_0001__p538818488578">This parameter can work together with the parameter <strong id="vpc_router_0001__vpc_api01_0003_b650614119446">limit</strong>.</p>
<ul id="vpc_router_0001__ul12704811125810"><li id="vpc_router_0001__vpc_api01_0003_li325418407124">If parameters <strong id="vpc_router_0001__vpc_api01_0003_b736582413514">marker</strong> and <strong id="vpc_router_0001__vpc_api01_0003_b17435293518">limit</strong> are not passed, all resource records will be returned.</li><li id="vpc_router_0001__vpc_api01_0003_li1923817171338">If the parameter <strong id="vpc_router_0001__vpc_api01_0003_b1505159195414">marker</strong> is not passed and the value of parameter <strong id="vpc_router_0001__vpc_api01_0003_b14146122925417">limit</strong> is set to <strong id="vpc_router_0001__vpc_api01_0003_b13594516546">10</strong>, the first 10 resource records will be returned.</li><li id="vpc_router_0001__vpc_api01_0003_li2076741203417">If the value of the parameter <strong id="vpc_router_0001__vpc_api01_0003_b13589356163415">marker</strong> is set to the resource ID of the 10th record and the value of parameter <strong id="vpc_router_0001__vpc_api01_0003_b1557415118357">limit</strong> is set to <strong id="vpc_router_0001__vpc_api01_0003_b10574171193511">10</strong>, the 11th to 20th resource records will be returned.</li><li id="vpc_router_0001__vpc_api01_0003_li108512113551">If the value of the parameter <strong id="vpc_router_0001__vpc_api01_0003_b9403193716543">marker</strong> is set to the resource ID of the 10th record and the parameter <strong id="vpc_router_0001__vpc_api01_0003_b10358823165519">limit</strong> is not passed, resource records starting from the 11th records (including 11th) will be returned.</li></ul>
</td>
</tr>
<tr id="vpc_router_0001__row7784191491713"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_router_0001__p278491421719">limit</p>
</td>
<td class="cellrowborder" valign="top" width="12.91129112911291%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_router_0001__p278431415173">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113211%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_router_0001__p7784201411173">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.65516551655165%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_router_0001__p2017153116589">Specifies the number of records that will be returned on each page. The value is from 0 to intmax.</p>
<p id="vpc_router_0001__p125192338584"><strong id="vpc_router_0001__vpc_api01_0003_b7164124258">limit</strong> can be used together with <strong id="vpc_router_0001__vpc_api01_0003_b15985310854">marker</strong>. For details, see the parameter description of <strong id="vpc_router_0001__vpc_api01_0003_b193281854847">marker</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="vpc_router_0001__section22539803205730"><h4 class="sectiontitle">Request Message</h4><p id="vpc_router_0001__p13784744205730">None</p>
</div>
<div class="section" id="vpc_router_0001__section56953834205730"><h4 class="sectiontitle">Response Message</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0001__table49857835205730" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_router_0001__row16977544205730"><th align="left" class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.3.6.2.2.4.1.1"><p id="vpc_router_0001__p33003808205730">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.11%" id="mcps1.3.6.2.2.4.1.2"><p id="vpc_router_0001__p56062768205730">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.540000000000006%" id="mcps1.3.6.2.2.4.1.3"><p id="vpc_router_0001__p4141274205730">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0001__row67007812205730"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.6.2.2.4.1.1 "><p id="vpc_router_0001__p58923719205730">routers</p>
</td>
<td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.6.2.2.4.1.2 "><p id="vpc_router_0001__p166911588244">Array of <a href="#vpc_router_0001__table24153696181443">router</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="59.540000000000006%" headers="mcps1.3.6.2.2.4.1.3 "><p id="vpc_router_0001__p7937265205730">Specifies the router list. For details, see <a href="#vpc_router_0001__table24153696181443">Table 3</a>.</p>
</td>
</tr>
<tr id="vpc_router_0001__row08813784314"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.6.2.2.4.1.1 "><p id="vpc_router_0001__p1377944234316">routers_links</p>
</td>
<td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.6.2.2.4.1.2 "><p id="vpc_router_0001__p1779204244317">Array of <a href="#vpc_router_0001__table25150247450">routers_link</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="59.540000000000006%" headers="mcps1.3.6.2.2.4.1.3 "><p id="vpc_router_0001__p11779184274317">Specifies the pagination information. For details, see <a href="#vpc_router_0001__table25150247450">Table 6</a>.</p>
<p id="vpc_router_0001__p1666711476161">The value of <strong id="vpc_router_0001__b6227143814611">rel</strong> will be <strong id="vpc_router_0001__b1523423818465">next</strong> and that of <strong id="vpc_router_0001__b8235138114618">href</strong> will be a link only when <strong id="vpc_router_0001__b172352389462">limit</strong> is used for filtering and the number of resources exceeds the value of <strong id="vpc_router_0001__b723553894618">limit</strong> or 2000 (default value of <strong id="vpc_router_0001__b12235838104619">limit</strong>).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_router_0001__table24153696181443"></a><a name="table24153696181443"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0001__table24153696181443" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_router_0001__b842352706142349">router</strong> objects</caption><thead align="left"><tr id="vpc_router_0001__row11861342181443"><th align="left" class="cellrowborder" valign="top" width="26.669999999999998%" id="mcps1.3.6.3.2.4.1.1"><p id="vpc_router_0001__p21244677181443"><strong id="vpc_router_0001__b12596154575614">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.330000000000002%" id="mcps1.3.6.3.2.4.1.2"><p id="vpc_router_0001__p43097239181443"><strong id="vpc_router_0001__b3295101414315">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.6.3.2.4.1.3"><p id="vpc_router_0001__p36728767181443"><strong id="vpc_router_0001__b1976615636">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0001__row22240136181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_router_0001__p56620590181443">id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_router_0001__p22865048181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_router_0001__p46905229181443">Specifies the router ID.</p>
<p id="vpc_router_0001__p121142486504">This parameter is not mandatory when you query routers.</p>
</td>
</tr>
<tr id="vpc_router_0001__row19493885181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_router_0001__p35500827181443">name</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_router_0001__p56994705181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_router_0001__p11978624181443">Specifies the router name.</p>
<p id="vpc_router_0001__p30744457181443">The name can contain only letters, digits, underscores (_), hyphens (-), and periods (.).</p>
</td>
</tr>
<tr id="vpc_router_0001__row8264657181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_router_0001__p65457453181443">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_router_0001__p453502181443">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_router_0001__p48641520181443">Specifies the administrative status.</p>
<p id="vpc_router_0001__p35120501181443">The value can only be <strong id="vpc_router_0001__b9364330194116">true</strong>.</p>
</td>
</tr>
<tr id="vpc_router_0001__row47649056181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_router_0001__p34368308181443">status</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_router_0001__p32369557181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_router_0001__p4016564181443">Specifies the router status. The value can be <strong id="vpc_router_0001__b842352706144324">ACTIVE</strong>, <strong id="vpc_router_0001__b842352706144328">DOWN</strong>, or <strong id="vpc_router_0001__b842352706144332">ERROR</strong>.</p>
</td>
</tr>
<tr id="vpc_router_0001__row36149082181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_router_0001__p42394506181443">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_router_0001__p11402971181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_router_0001__p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_router_0001__row26765861181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_router_0001__p20551115181443">external_gateway_info</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_router_0001__p54027655181443"><a href="#vpc_router_0001__table11448068181443">external_gateway_info</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_router_0001__p12911840181443">Specifies the external gateway. This is an extended attribute. For details, see the <strong id="vpc_router_0001__b842352706144447">external_gateway_info</strong> objects.</p>
</td>
</tr>
<tr id="vpc_router_0001__row49097702181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_router_0001__p17490925181443">routes</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_router_0001__p7478812181443">Array of <a href="#vpc_router_0001__table18829650181443">route</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_router_0001__p5122123194853">Specifies a route list. This is an extended attribute. For details, see <a href="#vpc_router_0001__table18829650181443">Table 5</a>.</p>
</td>
</tr>
<tr id="vpc_router_0001__row7278189151614"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_router_0001__p870051413911">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_router_0001__p15700614790">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_router_0001__p960410518269">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_router_0001__row172292215166"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_router_0001__p1953114119914">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_router_0001__p595318416919">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_router_0001__p1395374115919">Specifies the time (UTC) when the router is created.</p>
<p id="vpc_router_0001__p65980291419">Format: <em id="vpc_router_0001__i1191819548534">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
<tr id="vpc_router_0001__row106341917161611"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="vpc_router_0001__p139719548912">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.330000000000002%" headers="mcps1.3.6.3.2.4.1.2 "><p id="vpc_router_0001__p53971154594">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.4.1.3 "><p id="vpc_router_0001__p1339713549918">Specifies the time (UTC) when the router is updated.</p>
<p id="vpc_router_0001__p318184844718">Format: <em id="vpc_router_0001__i1065865135417">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_router_0001__table11448068181443"></a><a name="table11448068181443"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0001__table11448068181443" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_router_0001__b842352706145459">external_gateway_info</strong> objects</caption><thead align="left"><tr id="vpc_router_0001__row58732356181443"><th align="left" class="cellrowborder" valign="top" width="26.669999999999998%" id="mcps1.3.6.4.2.4.1.1"><p id="vpc_router_0001__p59700400181443"><strong id="vpc_router_0001__b11687111547">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.34%" id="mcps1.3.6.4.2.4.1.2"><p id="vpc_router_0001__p3894228181443"><strong id="vpc_router_0001__b1215717126545">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.99%" id="mcps1.3.6.4.2.4.1.3"><p id="vpc_router_0001__p1781307181443"><strong id="vpc_router_0001__b7181151310541">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0001__row10068178181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_router_0001__p10216081181443">network_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.34%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_router_0001__p22196257181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_router_0001__p38375206181443">Specifies the UUID of the external network.</p>
<p id="vpc_router_0001__p21383968181443">You can use <strong id="vpc_router_0001__b842352706145825">GET /v2.0/networks?router:external=True</strong> or run the <strong id="vpc_router_0001__b842352706145839">neutron net-external-list</strong> command to query information about the external network.</p>
</td>
</tr>
<tr id="vpc_router_0001__row58237990181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.4.2.4.1.1 "><p id="vpc_router_0001__p19656760181443">enable_snat</p>
</td>
<td class="cellrowborder" valign="top" width="23.34%" headers="mcps1.3.6.4.2.4.1.2 "><p id="vpc_router_0001__p48693751181443">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.6.4.2.4.1.3 "><p id="vpc_router_0001__p22976335181443">Specifies whether the SNAT function is enabled.</p>
<p id="vpc_router_0001__p49143812181443">The default value is <strong id="vpc_router_0001__b1611643349143731">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_router_0001__table18829650181443"></a><a name="table18829650181443"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0001__table18829650181443" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="vpc_router_0001__b1101195124012">route</strong> objects</caption><thead align="left"><tr id="vpc_router_0001__row60542282181443"><th align="left" class="cellrowborder" valign="top" width="26.669999999999998%" id="mcps1.3.6.5.2.4.1.1"><p id="vpc_router_0001__p4977811181443"><strong id="vpc_router_0001__b191835017558">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.34%" id="mcps1.3.6.5.2.4.1.2"><p id="vpc_router_0001__p549581181443"><strong id="vpc_router_0001__b153689135515">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.99%" id="mcps1.3.6.5.2.4.1.3"><p id="vpc_router_0001__p9206714181443"><strong id="vpc_router_0001__b124611220553">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0001__row7546366181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.5.2.4.1.1 "><p id="vpc_router_0001__p7275939181443">destination</p>
</td>
<td class="cellrowborder" valign="top" width="23.34%" headers="mcps1.3.6.5.2.4.1.2 "><p id="vpc_router_0001__p52480209181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.6.5.2.4.1.3 "><p id="vpc_router_0001__p66892155181443">Specifies the IP address range.</p>
</td>
</tr>
<tr id="vpc_router_0001__row65158490181443"><td class="cellrowborder" valign="top" width="26.669999999999998%" headers="mcps1.3.6.5.2.4.1.1 "><p id="vpc_router_0001__p43346313181443">nexthop</p>
</td>
<td class="cellrowborder" valign="top" width="23.34%" headers="mcps1.3.6.5.2.4.1.2 "><p id="vpc_router_0001__p21390453181443">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.6.5.2.4.1.3 "><p id="vpc_router_0001__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 class="tablenoborder"><a name="vpc_router_0001__table25150247450"></a><a name="table25150247450"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_router_0001__table25150247450" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="vpc_router_0001__b1585796122211">routers_link</strong> object</caption><thead align="left"><tr id="vpc_router_0001__row10561424184513"><th align="left" class="cellrowborder" valign="top" width="14.14%" id="mcps1.3.6.6.2.4.1.1"><p id="vpc_router_0001__p15562102474514"><strong id="vpc_router_0001__b13355108132215">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.14%" id="mcps1.3.6.6.2.4.1.2"><p id="vpc_router_0001__p656212464511"><strong id="vpc_router_0001__b10353109152216">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71.72%" id="mcps1.3.6.6.2.4.1.3"><p id="vpc_router_0001__p856220242456"><strong id="vpc_router_0001__b1484049132213">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_router_0001__row3562132464511"><td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.6.6.2.4.1.1 "><p id="vpc_router_0001__p13562224194510">href</p>
</td>
<td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.6.6.2.4.1.2 "><p id="vpc_router_0001__p556214245453">String</p>
</td>
<td class="cellrowborder" valign="top" width="71.72%" headers="mcps1.3.6.6.2.4.1.3 "><p id="vpc_router_0001__p145623247454">Specifies the API link.</p>
</td>
</tr>
<tr id="vpc_router_0001__row656292454519"><td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.6.6.2.4.1.1 "><p id="vpc_router_0001__p1756252484511">rel</p>
</td>
<td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.6.6.2.4.1.2 "><p id="vpc_router_0001__p056210247459">String</p>
</td>
<td class="cellrowborder" valign="top" width="71.72%" headers="mcps1.3.6.6.2.4.1.3 "><p id="vpc_router_0001__p75621724194516">Specifies the relationship between the API link and the API version.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_router_0001__section4326525205730"><h4 class="sectiontitle">Example</h4><p id="vpc_router_0001__p1921774513259">Example request</p>
<pre class="screen" id="vpc_router_0001__screen11573175611018">GET https://{Endpoint}/v2.0/routers?limit=1</pre>
</div>
<p id="vpc_router_0001__p114312313267">Example response</p>
<pre class="screen" id="vpc_router_0001__screen1454018714">{
"routers": [
{
"id": "01ab4be1-4447-45fb-94be-3ee787ed4ebe",
"name": "xiaoleizi-tag",
"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": [
{
"destination": "0.0.0.0/0",
"nexthop": "172.16.0.124"
}
],
"created_at": "2018-03-23T09:26:08",
"updated_at": "2018-08-24T08:49:53"
}
],
"routers_links": [
{
"rel": "next",
"href": "https://{Endpoint}/v2.0/routers?limit=1&amp;marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe"
},
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/routers?limit=1&amp;marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe&amp;page_reverse=True"
}
]
}</pre>
<div class="section" id="vpc_router_0001__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_router_0001__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="vpc_router_0001__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_router_0001__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