vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/er/api-ref/ShowStaticRoute.html
fanqinying ccc163eb84 ER API 20240805 version 
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>
2024-11-21 11:14:33 +00:00

236 lines
16 KiB
HTML
Raw Permalink Blame History

<a name="ShowStaticRoute"></a><a name="ShowStaticRoute"></a>
<h1 class="topictitle1">Querying Details About a Static Route</h1>
<div id="body1708331107508"><div class="section" id="ShowStaticRoute__section1380323416210"><h4 class="sectiontitle">Function</h4><p id="ShowStaticRoute__p18031934321">This API is used to query details about a static route.</p>
</div>
<div class="section" id="ShowStaticRoute__section68042034624"><h4 class="sectiontitle">URI</h4><p id="ShowStaticRoute__p1880414341026">GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowStaticRoute__table1080415341212" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowStaticRoute__row080410341212"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowStaticRoute__p10804163416212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowStaticRoute__p14805103417214">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowStaticRoute__p3805143411216">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowStaticRoute__p1080519341420">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowStaticRoute__row198041734924"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowStaticRoute__p380533419218">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowStaticRoute__p178052341210">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowStaticRoute__p48055349213">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowStaticRoute__p1080523418213">Project ID</p>
</td>
</tr>
<tr id="ShowStaticRoute__row880416341628"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowStaticRoute__p188051344215">route_table_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowStaticRoute__p6805634324">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowStaticRoute__p11805134527">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowStaticRoute__p680563416220">Route table ID</p>
</td>
</tr>
<tr id="ShowStaticRoute__row38047346219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowStaticRoute__p680653419212">route_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowStaticRoute__p68061834229">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowStaticRoute__p1680619341820">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowStaticRoute__p1806183414212">Route ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowStaticRoute__section2080673417215"><h4 class="sectiontitle">Request Parameters</h4><p id="ShowStaticRoute__p38069341626">None</p>
</div>
<div class="section" id="ShowStaticRoute__section1480616341825"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowStaticRoute__p12806183414215"><strong id="ShowStaticRoute__b780633417215">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowStaticRoute__response_RouteResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="ShowStaticRoute__row9806163418213"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowStaticRoute__p1080733414218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowStaticRoute__p6807834227">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowStaticRoute__p118075344218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowStaticRoute__row08061341022"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowStaticRoute__p98078341121">route</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowStaticRoute__p3807103414218"><a href="#ShowStaticRoute__response_Route">Route</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowStaticRoute__p1680773412211">Route</p>
</td>
</tr>
<tr id="ShowStaticRoute__row1980613348218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowStaticRoute__p1380718340220">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowStaticRoute__p15807034128">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowStaticRoute__p1280883414211">Request ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowStaticRoute__response_Route"></a><a name="response_Route"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowStaticRoute__response_Route" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Route</caption><thead align="left"><tr id="ShowStaticRoute__row480813345218"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowStaticRoute__p148098341928">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowStaticRoute__p58091634329">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowStaticRoute__p148091342212">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowStaticRoute__row580819341524"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowStaticRoute__p17809193415219">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowStaticRoute__p1980923417216">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowStaticRoute__p880917348216">Route ID</p>
</td>
</tr>
<tr id="ShowStaticRoute__row20808143419215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowStaticRoute__p5809123419210">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowStaticRoute__p1980916341219">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowStaticRoute__p11809113419217">Route type. The value is <strong id="ShowStaticRoute__b1880919341326">static</strong>.</p>
</td>
</tr>
<tr id="ShowStaticRoute__row2080810341223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowStaticRoute__p280913418217">state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowStaticRoute__p1980911347220">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowStaticRoute__p14810133415217">Route status. Value options: <strong id="ShowStaticRoute__b4810123418213">pending</strong>, <strong id="ShowStaticRoute__b18810113413216">available</strong>, <strong id="ShowStaticRoute__b11810134027">modifying</strong>, <strong id="ShowStaticRoute__b48105340217">deleting</strong>, <strong id="ShowStaticRoute__b1981018341828">deleted</strong>, and <strong id="ShowStaticRoute__b18109341626">failed</strong></p>
</td>
</tr>
<tr id="ShowStaticRoute__row1180817346211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowStaticRoute__p9810434324">is_blackhole</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowStaticRoute__p118106341927">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowStaticRoute__p8810153412219">Whether the route is a blackhole route</p>
</td>
</tr>
<tr id="ShowStaticRoute__row1780817347217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowStaticRoute__p581083416212">destination</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowStaticRoute__p1481013341211">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowStaticRoute__p281011349212">Destination address of the route</p>
</td>
</tr>
<tr id="ShowStaticRoute__row98089341428"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowStaticRoute__p48101234523">attachments</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowStaticRoute__p78101734129">Array of <a href="#ShowStaticRoute__response_RouteAttachment">RouteAttachment</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowStaticRoute__p16810103414219">Next hops</p>
</td>
</tr>
<tr id="ShowStaticRoute__row280893417215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowStaticRoute__p138105341123">route_table_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowStaticRoute__p4811334422">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowStaticRoute__p108112342024">Route table ID</p>
</td>
</tr>
<tr id="ShowStaticRoute__row680815341529"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowStaticRoute__p198111034725">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowStaticRoute__p1881114347217">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowStaticRoute__p14811153417217">Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ</p>
</td>
</tr>
<tr id="ShowStaticRoute__row188088342218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowStaticRoute__p1681119345215">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowStaticRoute__p081110342218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowStaticRoute__p38111342218">Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowStaticRoute__response_RouteAttachment"></a><a name="response_RouteAttachment"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowStaticRoute__response_RouteAttachment" frame="border" border="1" rules="all"><caption><b>Table 4 </b>RouteAttachment</caption><thead align="left"><tr id="ShowStaticRoute__row88131834127"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowStaticRoute__p3814534521">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowStaticRoute__p1881416342022">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowStaticRoute__p5814034223">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowStaticRoute__row1881323417218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowStaticRoute__p148147341221">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowStaticRoute__p18814934427">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowStaticRoute__p15814183419218">Attached resource ID</p>
</td>
</tr>
<tr id="ShowStaticRoute__row88134341222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowStaticRoute__p2814153412214">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowStaticRoute__p6814734221">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowStaticRoute__p1981419340214">Attachment type.</p>
<ul id="ShowStaticRoute__ul5814434525"><li id="ShowStaticRoute__li12814334425"><strong id="ShowStaticRoute__b381511341026">vpc</strong>: VPC attachment</li></ul>
</td>
</tr>
<tr id="ShowStaticRoute__row681314342219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowStaticRoute__p1981583414215">attachment_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowStaticRoute__p15815234623">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowStaticRoute__p19815113413210">Attachment ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowStaticRoute__section281514341729"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ShowStaticRoute__screen198153341320">GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/19d334b7-78c1-4e0e-ba29-b797e641e23c/static-routes/19d334b7-78c1-4e0e-ba29-b797e641e23c</pre>
</div>
<div class="section" id="ShowStaticRoute__section28151341325"><h4 class="sectiontitle">Example Responses</h4><p id="ShowStaticRoute__p18151334229"><strong id="ShowStaticRoute__b781515341829">Status code: 200</strong></p>
<p id="ShowStaticRoute__p781511343212">OK</p>
<pre class="screen" id="ShowStaticRoute__screen781612341626">{
"route" : {
"id" : "19d334b7-78c1-4e0e-ba29-b797e641e23c",
"type" : "static",
"destination" : "192.168.0.0/16",
"attachments" : [ {
"resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
"resource_type" : "VPC",
"attachment_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289"
} ],
"route_table_id" : "19d334b7-78c1-4e0e-ba29-b797e641e23c",
"is_blackhole" : false,
"state" : "pending",
"created_at" : "2020-03-11T15:13:31",
"updated_at" : "2020-03-11T15:13:31"
},
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}</pre>
</div>
<div class="section" id="ShowStaticRoute__section581718341220"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowStaticRoute__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowStaticRoute__row1781723411219"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowStaticRoute__p681714341726">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowStaticRoute__p1181719341229">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowStaticRoute__row118171534121"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowStaticRoute__p1081715346211">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowStaticRoute__p17818634722">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowStaticRoute__section1581815341825"><h4 class="sectiontitle">Error Codes</h4><p id="ShowStaticRoute__p5818173419210">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="Route.html">Routes</a></div>
</div>
</div>
View Git Blame Copy Permalink