forked from docs/doc-exports
fanqinying
9e7606681c
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: fanqinying <fanqinying@huawei.com> Co-committed-by: fanqinying <fanqinying@huawei.com>
348 lines
34 KiB
HTML
348 lines
34 KiB
HTML
<a name="vpc_apiroutetab_0001"></a><a name="vpc_apiroutetab_0001"></a>
|
|
|
|
<h1 class="topictitle1">Querying Route Tables</h1>
|
|
<div id="body1548666369734"><div class="section" id="vpc_apiroutetab_0001__section8592173071319"><h4 class="sectiontitle">Function</h4><p id="vpc_apiroutetab_0001__p19153431151317">This API is used to query route tables.</p>
|
|
</div>
|
|
<div class="section" id="vpc_apiroutetab_0001__section759213011320"><h4 class="sectiontitle">URI</h4><p id="vpc_apiroutetab_0001__p715319312130">GET /v1/{project_id}/routetables</p>
|
|
<p id="vpc_apiroutetab_0001__p171414235143">Example:</p>
|
|
<pre class="screen" id="vpc_apiroutetab_0001__screen146081437171413">GET https://{Endpoint}/v1/{project_id}/routetables?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85&subnet_id=9873b33f-ac1c-4630-ad1c-7dba1ed79r78</pre>
|
|
<p id="vpc_apiroutetab_0001__p4528742101111"><a href="#vpc_apiroutetab_0001__table135921530121310">Table 1</a> describes the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="vpc_apiroutetab_0001__table135921530121310"></a><a name="table135921530121310"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiroutetab_0001__table135921530121310" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_apiroutetab_0001__row1015323118139"><th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.2.6.2.5.1.1"><p id="vpc_apiroutetab_0001__p191531531151318"><strong id="vpc_apiroutetab_0001__b518920577184">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.19191919191919%" id="mcps1.3.2.6.2.5.1.2"><p id="vpc_apiroutetab_0001__p21532313135"><strong id="vpc_apiroutetab_0001__b17439175820181">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.19191919191919%" id="mcps1.3.2.6.2.5.1.3"><p id="vpc_apiroutetab_0001__p191531031161311"><strong id="vpc_apiroutetab_0001__b9975105914184">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.40404040404041%" id="mcps1.3.2.6.2.5.1.4"><p id="vpc_apiroutetab_0001__p815373118134"><strong id="vpc_apiroutetab_0001__b156015015195">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_apiroutetab_0001__row2015363114137"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.6.2.5.1.1 "><p id="vpc_apiroutetab_0001__p1215311319136">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.2 "><p id="vpc_apiroutetab_0001__p1115373116138">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.3 "><p id="vpc_apiroutetab_0001__p20153173120135">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.40404040404041%" headers="mcps1.3.2.6.2.5.1.4 "><p id="vpc_apiroutetab_0001__p10487112">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row161533316131"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.6.2.5.1.1 "><p id="vpc_apiroutetab_0001__p121532316137">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.2 "><p id="vpc_apiroutetab_0001__p18153163191319">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.3 "><p id="vpc_apiroutetab_0001__p15153133118136">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.40404040404041%" headers="mcps1.3.2.6.2.5.1.4 "><p id="vpc_apiroutetab_0001__p2017153116589">Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000.</p>
|
|
<p id="vpc_apiroutetab_0001__p125192338584"><strong id="vpc_apiroutetab_0001__vpc_api01_0003_b7164124258">limit</strong> can be used together with <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b15985310854">marker</strong>. For details, see the parameter description of <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b193281854847">marker</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row10153731191319"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.6.2.5.1.1 "><p id="vpc_apiroutetab_0001__p14153631131313">marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.2 "><p id="vpc_apiroutetab_0001__p13153731181318">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.3 "><p id="vpc_apiroutetab_0001__p1315318312132">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.40404040404041%" headers="mcps1.3.2.6.2.5.1.4 "><p id="vpc_apiroutetab_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_apiroutetab_0001__p538818488578">This parameter can work together with the parameter <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b650614119446">limit</strong>.</p>
|
|
<ul id="vpc_apiroutetab_0001__ul12704811125810"><li id="vpc_apiroutetab_0001__vpc_api01_0003_li325418407124">If parameters <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b736582413514">marker</strong> and <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b17435293518">limit</strong> are not passed, resource records on the first page will be returned.</li><li id="vpc_apiroutetab_0001__vpc_api01_0003_li1923817171338">If the parameter <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b1505159195414">marker</strong> is not passed and the value of parameter <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b14146122925417">limit</strong> is set to <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b13594516546">10</strong>, the first 10 resource records will be returned.</li><li id="vpc_apiroutetab_0001__vpc_api01_0003_li2076741203417">If the value of the parameter <strong id="vpc_apiroutetab_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_apiroutetab_0001__vpc_api01_0003_b1557415118357">limit</strong> is set to <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b10574171193511">10</strong>, the 11th to 20th resource records will be returned.</li><li id="vpc_apiroutetab_0001__vpc_api01_0003_li108512113551">If the value of the parameter <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b9403193716543">marker</strong> is set to the resource ID of the 10th record and the parameter <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b10358823165519">limit</strong> is not passed, 11th to 2,000th resource records will be returned. The default value of <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b112010101639">limit</strong> is <strong id="vpc_apiroutetab_0001__vpc_api01_0003_b206061121438">2000</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row143341450123315"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.6.2.5.1.1 "><p id="vpc_apiroutetab_0001__p133535015333">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.2 "><p id="vpc_apiroutetab_0001__p14326517123417">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.3 "><p id="vpc_apiroutetab_0001__p232661713341">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.40404040404041%" headers="mcps1.3.2.6.2.5.1.4 "><p id="vpc_apiroutetab_0001__p1533511509339">Specifies the route table ID that is used as the filter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row11531931141312"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.6.2.5.1.1 "><p id="vpc_apiroutetab_0001__p315343141313">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.2 "><p id="vpc_apiroutetab_0001__p1715373191317">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.3 "><p id="vpc_apiroutetab_0001__p1015353191319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.40404040404041%" headers="mcps1.3.2.6.2.5.1.4 "><p id="vpc_apiroutetab_0001__p21531331191317">Specifies the VPC UUID that is used as the filter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row11153123119138"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.6.2.5.1.1 "><p id="vpc_apiroutetab_0001__p1415353117132">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.2 "><p id="vpc_apiroutetab_0001__p13153731131318">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.6.2.5.1.3 "><p id="vpc_apiroutetab_0001__p1715373110135">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.40404040404041%" headers="mcps1.3.2.6.2.5.1.4 "><p id="vpc_apiroutetab_0001__p6153173116130">Specifies the subnet UUID that is used as the filter.</p>
|
|
<p id="vpc_apiroutetab_0001__p14535204413508">If you use the management console, the value of this parameter is the <strong id="vpc_apiroutetab_0001__vpc_subnet01_0002_b195522519461">Network ID</strong> value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_apiroutetab_0001__section1263863011138"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_apiroutetab_0001__p14153131191319">None</p>
|
|
</div>
|
|
<div class="section" id="vpc_apiroutetab_0001__section1321717219148"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_apiroutetab_0001__screen182712135267">GET https://{Endpoint}/v1/{project_id}/routetables?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85&subnet_id=9873b33f-ac1c-4630-ad1c-7dba1ed79r78</pre>
|
|
</div>
|
|
<div class="section" id="vpc_apiroutetab_0001__section36381130191314"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiroutetab_0001__table9654730151314" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_apiroutetab_0001__row1015383161310"><th align="left" class="cellrowborder" valign="top" width="23.232323232323232%" id="mcps1.3.5.2.2.4.1.1"><p id="vpc_apiroutetab_0001__p1515333191316"><strong id="vpc_apiroutetab_0001__b143271396221">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32.32323232323232%" id="mcps1.3.5.2.2.4.1.2"><p id="vpc_apiroutetab_0001__p01532031141317"><strong id="vpc_apiroutetab_0001__b1459104042220">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.44444444444445%" id="mcps1.3.5.2.2.4.1.3"><p id="vpc_apiroutetab_0001__p171531031101319"><strong id="vpc_apiroutetab_0001__b7249144117221">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_apiroutetab_0001__row161531431161316"><td class="cellrowborder" valign="top" width="23.232323232323232%" headers="mcps1.3.5.2.2.4.1.1 "><p id="vpc_apiroutetab_0001__p18153133101310">routetables</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32.32323232323232%" headers="mcps1.3.5.2.2.4.1.2 "><p id="vpc_apiroutetab_0001__p75521842031">Array of <a href="#vpc_apiroutetab_0001__table5685153016131">routetable</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.44444444444445%" headers="mcps1.3.5.2.2.4.1.3 "><p id="vpc_apiroutetab_0001__p11153531181310">Specifies the route table list. For details, see <a href="#vpc_apiroutetab_0001__table5685153016131">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_apiroutetab_0001__table5685153016131"></a><a name="table5685153016131"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiroutetab_0001__table5685153016131" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="vpc_apiroutetab_0001__b53351219172316">routetable</strong> field</caption><thead align="left"><tr id="vpc_apiroutetab_0001__row2153143113131"><th align="left" class="cellrowborder" valign="top" width="22.45%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_apiroutetab_0001__p11153203171311"><strong id="vpc_apiroutetab_0001__b433582020234">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.45%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_apiroutetab_0001__p16153103141315"><strong id="vpc_apiroutetab_0001__b13299421192320">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.1%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_apiroutetab_0001__p41531131161315"><strong id="vpc_apiroutetab_0001__b5174182210230">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_apiroutetab_0001__row101531031111314"><td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiroutetab_0001__p151531313136">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiroutetab_0001__p315343151313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul1815353171319"><li id="vpc_apiroutetab_0001__li181532318139">Specifies the route table ID that uniquely identifies a route table.</li><li id="vpc_apiroutetab_0001__li3153531201316">The value must be in standard UUID format.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row191533312137"><td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiroutetab_0001__p91531631181315">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiroutetab_0001__p10153163111137">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul1915323113139"><li id="vpc_apiroutetab_0001__li3153113115138">Specifies the route table name.</li><li id="vpc_apiroutetab_0001__li171531731181319">The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row7153331191314"><td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiroutetab_0001__p1815318314131">default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiroutetab_0001__p4153331111318">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul51531531151314"><li id="vpc_apiroutetab_0001__li2153123111137">Specifies whether the route table is the default one.</li><li id="vpc_apiroutetab_0001__li915313171311">The value can be <strong id="vpc_apiroutetab_0001__b203715672411">true</strong> (default route table) or <strong id="vpc_apiroutetab_0001__b1432413552514">false</strong> (custom route table).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row1346411562104"><td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiroutetab_0001__p1122203915571">routes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiroutetab_0001__p1269685835715">Array of <a href="#vpc_apiroutetab_0001__table1687317463915">route</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul086816394595"><li id="vpc_apiroutetab_0001__li15868103955918">Specifies the route list. For details, see <a href="#vpc_apiroutetab_0001__table1687317463915">Table 4</a>.</li><li id="vpc_apiroutetab_0001__li326581711292">Each route table can have a maximum of 200 routes.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row515318312131"><td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiroutetab_0001__p14153133111134">subnets</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiroutetab_0001__p315315313135">Array of <a href="#vpc_apiroutetab_0001__table4856530131313">subnet</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul3153431131314"><li id="vpc_apiroutetab_0001__li171536312133">Specifies the subnets associated with the route table. For details, see <a href="#vpc_apiroutetab_0001__table4856530131313">Table 5</a>.</li><li id="vpc_apiroutetab_0001__li10153831121316">Only subnets in the VPC to which the route table belongs can be associated with the route table.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row31531731141313"><td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiroutetab_0001__p1715333191318">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiroutetab_0001__p9153173114136">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul16478202755010"><li id="vpc_apiroutetab_0001__li1547832714507">Specifies the project ID.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row1915313114132"><td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiroutetab_0001__p1415393118135">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiroutetab_0001__p81531531201312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul31089364503"><li id="vpc_apiroutetab_0001__li12108133610504">Specifies the ID of the VPC associated with the route table.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row1215373114136"><td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiroutetab_0001__p161536314133">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiroutetab_0001__p181538313131">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul9153531151310"><li id="vpc_apiroutetab_0001__li915323112133">Provides supplementary information about the route table.</li><li id="vpc_apiroutetab_0001__li1415323111313">The value can contain up to 255 characters and cannot contain angle brackets (< or >).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row12203141213279"><td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiroutetab_0001__p106711441172119">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiroutetab_0001__p867112418216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul13463133512"><li id="vpc_apiroutetab_0001__li114610173513">Specifies the time (UTC) when the route table is created.</li><li id="vpc_apiroutetab_0001__li84711133511">Format: <em id="vpc_apiroutetab_0001__i71071728172220">yyyy-MM-ddTHH:mm:ss</em></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row1420471262720"><td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiroutetab_0001__p96711541192118">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiroutetab_0001__p1467116412217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul9899124133520"><li id="vpc_apiroutetab_0001__li128991544351">Specifies the time (UTC) when the route table is updated.</li><li id="vpc_apiroutetab_0001__li989913413351">Format: <em id="vpc_apiroutetab_0001__i17582633132210">yyyy-MM-ddTHH:mm:ss</em></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_apiroutetab_0001__table1687317463915"></a><a name="table1687317463915"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiroutetab_0001__table1687317463915" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="vpc_apiroutetab_0001__b43887611587">route</strong> field</caption><thead align="left"><tr id="vpc_apiroutetab_0001__vpc_apiroutetab_0001_row515383161311"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.4.2.4.1.1"><p id="vpc_apiroutetab_0001__vpc_apiroutetab_0001_p2153931101310">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.4.2.4.1.2"><p id="vpc_apiroutetab_0001__vpc_apiroutetab_0001_p3153173181310"><strong id="vpc_apiroutetab_0001__b1487500256">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.5.4.2.4.1.3"><p id="vpc_apiroutetab_0001__vpc_apiroutetab_0001_p1415312315135">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_apiroutetab_0001__row1279917312363"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiroutetab_0001__p1480043123618">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiroutetab_0001__p158001311368">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul18902107153719"><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li13194174943813">Specifies the route type.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li1719418493388">Values:<ul id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_ul16261353173811"><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li19020720376"><strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b193325221666">ecs</strong> (ECS)</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li109021479374"><strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b1829722314619">eni</strong> (NIC)</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li1790220753714"><strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b22746249616">vip</strong> (Virtual IP address)</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li49028715373"><strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b1928920893020">nat</strong> (NAT gateway)</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li109023723719"><strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b1380518261296">peering</strong> (VPC peering connection)</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li3902777379"><strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b116334289290">vpn</strong> (VPN)</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li490317183717"><strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b11814429112920">dc</strong> (Direct Connect connection)</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li390320743713"><strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b14690112514523">egw</strong>: VPC endpoint. This route type is not supported.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li1762023194020"><strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b2082313198401">er</strong>: enterprise router</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li176942105378"><strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b19253062103">subeni</strong>: supplementary network interface. This type of route cannot be created or updated by users.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li89692309136"><strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b46488541257">local</strong>: reserved CIDR block. The destination CIDR block of the route configured cannot overlap with that defined by <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b12961114419475">local</strong>.</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__vpc_apiroutetab_0001_row1815318312139"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiroutetab_0001__vpc_apiroutetab_0001_p315333113133">destination</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiroutetab_0001__vpc_apiroutetab_0001_p815343121311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiroutetab_0001__vpc_apiroutetab_0001_ul1515313116131"><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_vpc_apiroutetab_0001_li2015312310139">Specifies the destination CIDR block of a route.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_vpc_apiroutetab_0001_li515316311133">Constraints: The value must be in valid IPv4 or IPv6 CIDR formats.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__vpc_apiroutetab_0001_row915313171320"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiroutetab_0001__vpc_apiroutetab_0001_p1153173111318">nexthop</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiroutetab_0001__vpc_apiroutetab_0001_p141531331141316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul99929820391"><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li139928812396">Specifies the ID of the next hop in the route.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li3992684394">Values:<ul id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_ul7886201515396"><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li699210815391">When <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b1133715543297">type</strong> is <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b193381354102918">ecs</strong>, the value is an ECS ID.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li1499208133920">When <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b5230155652910">type</strong> is <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b1323015560298">eni</strong>, the value is an extension NIC ID.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li109922818396">When <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b103481157192910">type</strong> is <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b1034917576294">vip</strong>, the value is a virtual IP address.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li11992583397">When <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b4409558182911">type</strong> is <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b20410195822918">nat</strong>, the value a NAT gateway ID.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li119929819391">When <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b7522159152914">type</strong> is <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b1452215962914">peering</strong>, the value is a VPC peering connection ID.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li1399220813913">When <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b32791405309">type</strong> is <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b14280110143012">vpn</strong>, the value is a VPN ID.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li179925810397">When <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b9222016303">type</strong> is <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b162248163015">dc</strong>, the value is a Direct Connect connection ID.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li4774843203312">When <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b137248253258">type</strong> is set to <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b8510112852517">egw</strong>, the value is a VPC endpoint ID.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li7973111319409">When <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b251935344110">type</strong> is set to <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b185198539416">er</strong>, the value is the ID of an enterprise router.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li5776204312381">When <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b08319964316">type</strong> is set to <strong id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_b3835954312">subeni</strong>, the value is the ID of a supplementary network interface.</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiroutetab_0001__row1343283418367"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiroutetab_0001__p13432734173616">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiroutetab_0001__p19432133423620">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiroutetab_0001__ul18155710164020"><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li15155201024020">Provides supplementary information about the route.</li><li id="vpc_apiroutetab_0001__vpc_apiroutetab_0002_li415520107401">The value can contain up to 255 characters and cannot contain angle brackets (< or >).</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_apiroutetab_0001__table4856530131313"></a><a name="table4856530131313"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiroutetab_0001__table4856530131313" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Description of the <strong id="vpc_apiroutetab_0001__b14181491115">subnet</strong> field</caption><thead align="left"><tr id="vpc_apiroutetab_0001__row171531331131310"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.5.2.4.1.1"><p id="vpc_apiroutetab_0001__p6153173121320"><strong id="vpc_apiroutetab_0001__b1935205112115">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.5.2.4.1.2"><p id="vpc_apiroutetab_0001__p191537315136"><strong id="vpc_apiroutetab_0001__b1646311523114">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.5.5.2.4.1.3"><p id="vpc_apiroutetab_0001__p15153173119138"><strong id="vpc_apiroutetab_0001__b193346530117">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_apiroutetab_0001__row1015343151311"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="vpc_apiroutetab_0001__p1153153110133">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="vpc_apiroutetab_0001__p8153163112134">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="vpc_apiroutetab_0001__p141761235103513">Specifies the ID of the subnet associated with the route table.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_apiroutetab_0001__section12249115711142"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="vpc_apiroutetab_0001__screen1761782263610">{
|
|
"routetables": [
|
|
{
|
|
"id": "3d42a0d4-a980-4613-ae76-a2cddecff054",
|
|
"name": "routetable-1234",
|
|
"vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff",
|
|
"routes": [
|
|
{
|
|
"type": "local",
|
|
"destination": "192.168.4.0/24",
|
|
"nexthop": "-"
|
|
},
|
|
{
|
|
"type": "local",
|
|
"destination": "192.168.1.0/24",
|
|
"nexthop": "-"
|
|
},
|
|
{
|
|
"type": "local",
|
|
"destination": "198.19.128.0/20",
|
|
"nexthop": "-"
|
|
},
|
|
{
|
|
"type": "local",
|
|
"destination": "127.0.0.0/8",
|
|
"nexthop": "-"
|
|
},
|
|
{
|
|
"type": "local",
|
|
"destination": "100.64.0.0/10",
|
|
"nexthop": "-"
|
|
}
|
|
],
|
|
"subnets": [
|
|
{
|
|
"id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f"
|
|
}
|
|
],
|
|
"tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
|
|
"description": "abc",
|
|
"created_at": "2022-12-15T02:56:40",
|
|
"updated_at": "2022-12-15T02:56:40"
|
|
},
|
|
{
|
|
"id": "3d42a0d4-a980-4613-ae76-a2cddecfff89",
|
|
"name": "routetable-5678",
|
|
"vpc_id": "ab78be2d-782f-42a5-aa72-35879f667809",
|
|
"routes": [
|
|
{
|
|
"type": "local",
|
|
"destination": "192.168.4.0/24",
|
|
"nexthop": "-"
|
|
},
|
|
{
|
|
"type": "local",
|
|
"destination": "192.168.1.0/24",
|
|
"nexthop": "-"
|
|
},
|
|
{
|
|
"type": "local",
|
|
"destination": "198.19.128.0/20",
|
|
"nexthop": "-"
|
|
},
|
|
{
|
|
"type": "local",
|
|
"destination": "127.0.0.0/8",
|
|
"nexthop": "-"
|
|
},
|
|
{
|
|
"type": "local",
|
|
"destination": "100.64.0.0/10",
|
|
"nexthop": "-"
|
|
}
|
|
],
|
|
"subnets": [
|
|
{
|
|
"id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f"
|
|
}
|
|
],
|
|
"tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
|
|
"description": "abc",
|
|
"created_at": "2022-12-15T02:59:03",
|
|
"updated_at": "2022-12-15T02:59:03"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="vpc_apiroutetab_0001__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_apiroutetab_0001__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_apiroutetab_0001__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_apiroutetab_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_apiroutetab_0000.html">Route Table</a></div>
|
|
</div>
|
|
</div>
|
|
|