forked from docs/doc-exports
Qin Ying, Fan
310d2d9eb1
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>
132 lines
10 KiB
HTML
132 lines
10 KiB
HTML
<a name="vpc_route_0002"></a><a name="vpc_route_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying a VPC Route</h1>
|
|
<div id="body1504753416894"><div class="section" id="vpc_route_0002__section854682151220"><h4 class="sectiontitle">Function</h4><p id="vpc_route_0002__p16851221181213">This API is used to query details about a route.</p>
|
|
</div>
|
|
<div class="section" id="vpc_route_0002__section3547821101219"><h4 class="sectiontitle">URI</h4><p id="vpc_route_0002__p19493347184212">GET /v2.0/vpc/routes/{route_id}</p>
|
|
<div class="p" id="vpc_route_0002__p886814117"><a href="#vpc_route_0002__table18880184689">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="vpc_route_0002__table18880184689"></a><a name="table18880184689"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_route_0002__table18880184689" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_route_0002__row13968641385"><th align="left" class="cellrowborder" valign="top" width="22.222222222222225%" id="mcps1.3.2.3.2.2.5.1.1"><p id="vpc_route_0002__p209684410817"><strong id="vpc_route_0002__b842352706195711">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.14141414141414%" id="mcps1.3.2.3.2.2.5.1.2"><p id="vpc_route_0002__p69681441386"><strong id="vpc_route_0002__b84235270615219">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.27272727272727%" id="mcps1.3.2.3.2.2.5.1.3"><p id="vpc_route_0002__p1096813412811"><strong id="vpc_route_0002__b842352706145623">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.36363636363636%" id="mcps1.3.2.3.2.2.5.1.4"><p id="vpc_route_0002__p139686416813"><strong id="vpc_route_0002__b8423527061645">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_route_0002__row19681041189"><td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="vpc_route_0002__p1013244217196">route_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="vpc_route_0002__p1797015416817">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="vpc_route_0002__p19701411813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="vpc_route_0002__p123881427145">Specifies the route ID, which uniquely identifies the route.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_route_0002__section11553182191214"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_route_0002__p56861821161213">None</p>
|
|
</div>
|
|
<div class="section" id="vpc_route_0002__section11207507136"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_route_0002__screen1687152171219">GET https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9</pre>
|
|
</div>
|
|
<div class="section" id="vpc_route_0002__section6554102119123"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_route_0002__table355410218123" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_route_0002__row1168714210128"><th align="left" class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.3.5.2.2.4.1.1"><p id="vpc_route_0002__p5687821191213">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.48%" id="mcps1.3.5.2.2.4.1.2"><p id="vpc_route_0002__p20687202118122">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65.16999999999999%" id="mcps1.3.5.2.2.4.1.3"><p id="vpc_route_0002__p4687102113129">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_route_0002__row2068712111129"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.5.2.2.4.1.1 "><p id="vpc_route_0002__p176872021121212">route</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.48%" headers="mcps1.3.5.2.2.4.1.2 "><p id="vpc_route_0002__p1368732191211"><a href="vpc_route_0002.html">route</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.16999999999999%" headers="mcps1.3.5.2.2.4.1.3 "><p id="vpc_route_0002__p16438204318114">Specifies the route. For details, see <a href="#vpc_route_0002__table05001250111">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_route_0002__table05001250111"></a><a name="table05001250111"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_route_0002__table05001250111" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_route_0002__b216190121817">route</strong> objects</caption><thead align="left"><tr id="vpc_route_0002__row1604152531116"><th align="left" class="cellrowborder" valign="top" width="19.321932193219325%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_route_0002__p19605525151115"><strong id="vpc_route_0002__b127281319183">Attribute</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.172417241724172%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_route_0002__p2060572511111"><strong id="vpc_route_0002__b17283814101819">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.5056505650565%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_route_0002__p11605425111120"><strong id="vpc_route_0002__b1966810394191">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_route_0002__row19605172516117"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_route_0002__p4605625141117">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_route_0002__p4605425191116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_route_0002__p136051025171110">Specifies the route ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0002__row19605192511115"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_route_0002__p1160582510117">destination</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_route_0002__p186051725131113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_route_0002__p20605425121118">Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0002__row160513252111"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_route_0002__p76051225121114">nexthop</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_route_0002__p1460592591111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_route_0002__p487414894012">Specifies the next hop. If the route type is <strong id="vpc_route_0002__b1665776122017">peering</strong>, enter the VPC peering connection ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0002__row26061325191110"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_route_0002__p86067257112">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_route_0002__p260619251118">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_route_0002__p9916134014397">Specifies the route type. Currently, the value can only be <strong id="vpc_route_0002__b1198002102012">peering</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0002__row11606125111110"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_route_0002__p12606162501119">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_route_0002__p06061925181119">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_route_0002__p9606112519111">Specifies the VPC of the route. Set this parameter to the existing VPC ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0002__row56067256117"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_route_0002__p196065257115">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_route_0002__p10606182591115">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_route_0002__p10487112">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_route_0002__section01811116121311"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="vpc_route_0002__screen10687102181213">{
|
|
"route": {
|
|
"type": "peering",
|
|
"nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9",
|
|
"destination": "192.168.200.0/24",
|
|
"vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff",
|
|
"tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
|
|
"id": "3d42a0d4-a980-4613-ae76-a2cddecff054"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="vpc_route_0002__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_route_0002__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_route_0002__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_route_0002__p17281622133910">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_route_0000.html">VPC Route</a></div>
|
|
</div>
|
|
</div>
|
|
|