forked from docs/doc-exports
gtema
4cfecba474
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>
190 lines
14 KiB
HTML
190 lines
14 KiB
HTML
<a name="vpc_route_0003"></a><a name="vpc_route_0003"></a>
|
|
|
|
<h1 class="topictitle1">Creating a VPC Route</h1>
|
|
<div id="body1504753416894"><div class="section" id="vpc_route_0003__section47901846151217"><h4 class="sectiontitle">Function</h4><p id="vpc_route_0003__p1394674615121">This API is used to create a route.</p>
|
|
</div>
|
|
<div class="section" id="vpc_route_0003__section13791164631218"><h4 class="sectiontitle">URI</h4><p id="vpc_route_0003__p55511843194514">POST /v2.0/vpc/routes</p>
|
|
</div>
|
|
<div class="section" id="vpc_route_0003__section3797746131211"><h4 class="sectiontitle">Request Message</h4><ul id="vpc_route_0003__ul1916414447476"><li id="vpc_route_0003__li1516414454711">Request parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_route_0003__table1798124601216" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="vpc_route_0003__row9947104641211"><th align="left" class="cellrowborder" valign="top" width="14.14%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="vpc_route_0003__p15947546131217">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="8.08%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="vpc_route_0003__p1094744610126">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="8.08%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="vpc_route_0003__p3947104631217">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="69.69999999999999%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="vpc_route_0003__p17947154661210">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_route_0003__row20947134611120"><td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpc_route_0003__p1947194618124">route</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="8.08%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpc_route_0003__p179478465125"><a href="vpc_route_0003.html">route</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="8.08%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpc_route_0003__p094714468129">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.69999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpc_route_0003__p16438204318114">Specifies the route. For details, see <a href="#vpc_route_0003__table05001250111">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_route_0003__table05001250111"></a><a name="table05001250111"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_route_0003__table05001250111" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="vpc_route_0003__b18402937111610">route</strong> objects</caption><thead align="left"><tr id="vpc_route_0003__row1604152531116"><th align="left" class="cellrowborder" valign="top" width="21.26%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="vpc_route_0003__p19605525151115"><strong id="vpc_route_0003__b84235270610290">Attribute</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.66%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="vpc_route_0003__p2060572511111"><strong id="vpc_route_0003__b461371982118">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.580000000000002%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="vpc_route_0003__p91930461309"><strong id="vpc_route_0003__b455202132114">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37.5%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="vpc_route_0003__p11605425111120"><strong id="vpc_route_0003__b165331351217">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_route_0003__row19605192511115"><td class="cellrowborder" valign="top" width="21.26%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpc_route_0003__p1160582510117">destination</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpc_route_0003__p186051725131113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpc_route_0003__p1819354623012">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.5%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpc_route_0003__p20605425121118">Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0003__row160513252111"><td class="cellrowborder" valign="top" width="21.26%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpc_route_0003__p76051225121114">nexthop</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpc_route_0003__p1460592591111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpc_route_0003__p0193184613307">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.5%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpc_route_0003__p487414894012">Specifies the next hop. If the route type is <strong id="vpc_route_0003__b165464457218">peering</strong>, enter the VPC peering connection ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0003__row26061325191110"><td class="cellrowborder" valign="top" width="21.26%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpc_route_0003__p86067257112">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpc_route_0003__p260619251118">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpc_route_0003__p319310462306">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.5%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpc_route_0003__p9916134014397">Specifies the route type. Currently, the value can only be <strong id="vpc_route_0003__b2561175215211">peering</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0003__row11606125111110"><td class="cellrowborder" valign="top" width="21.26%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpc_route_0003__p12606162501119">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpc_route_0003__p06061925181119">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpc_route_0003__p819334617303">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.5%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpc_route_0003__p9606112519111">Specifies the ID of the VPC ID requesting for creating a route.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="vpc_route_0003__li1186735514715">Example request<pre class="screen" id="vpc_route_0003__screen79476468122">POST https://{Endpoint}/v2.0/vpc/routes
|
|
|
|
{
|
|
"route": {
|
|
"type": "peering",
|
|
"nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9",
|
|
"destination": "192.168.200.0/24",
|
|
"vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_route_0003__section1680694610122"><h4 class="sectiontitle">Response Message</h4><ul id="vpc_route_0003__ul8282125913485"><li id="vpc_route_0003__li0282259114811">Response parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_route_0003__table158077469123" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter</caption><thead align="left"><tr id="vpc_route_0003__row994734618124"><th align="left" class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpc_route_0003__p159471246131219">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.48%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpc_route_0003__p59471646191212">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65.16999999999999%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpc_route_0003__p12947114615129">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_route_0003__row18947144601211"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpc_route_0003__p1794734651219">route</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.48%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpc_route_0003__p19471546151212"><a href="vpc_route_0003.html">route</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.16999999999999%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpc_route_0003__p16548142183616">Specifies the route. For details, see <a href="#vpc_route_0003__table1163544010410">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_route_0003__table1163544010410"></a><a name="table1163544010410"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_route_0003__table1163544010410" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_route_0003__b0320164132210">route</strong> objects</caption><thead align="left"><tr id="vpc_route_0003__row863564014119"><th align="left" class="cellrowborder" valign="top" width="19.321932193219325%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpc_route_0003__p1463514017412"><strong id="vpc_route_0003__b1622134242212">Attribute</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.172417241724172%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpc_route_0003__p5635240154118"><strong id="vpc_route_0003__b82861243172210">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.5056505650565%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpc_route_0003__p563554018417"><strong id="vpc_route_0003__b535718446221">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_route_0003__row19605172516117"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_route_0003__p4605625141117">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_route_0003__p4605425191116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_route_0003__p136051025171110">Specifies the route ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0003__row9635134015418"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_route_0003__p16354403419">destination</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_route_0003__p9635164004115">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_route_0003__p1863514018419">Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0003__row7635840174120"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_route_0003__p166351040174117">nexthop</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_route_0003__p18635740104120">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_route_0003__p16361640134116">Specifies the next hop. If the route type is <strong id="vpc_route_0003__b92551057192413">peering</strong>, enter the VPC peering connection ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0003__row1563604034114"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_route_0003__p56361240184111">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_route_0003__p11636174019411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_route_0003__p14636134094111">Specifies the route type. Currently, the value can only be <strong id="vpc_route_0003__b1210519215259">peering</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0003__row563614017419"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_route_0003__p3636240124118">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_route_0003__p06361940114114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_route_0003__p166361940154117">Specifies the VPC of the route. Set this parameter to the existing VPC ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_route_0003__row56067256117"><td class="cellrowborder" valign="top" width="19.321932193219325%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_route_0003__p196065257115">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_route_0003__p10606182591115">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.5056505650565%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_route_0003__p10487112">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="vpc_route_0003__ul117621119491"><li id="vpc_route_0003__li107627124915">Example response<pre class="screen" id="vpc_route_0003__screen69481046181211">{
|
|
"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>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_route_0003__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_route_0003__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_route_0003__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_route_0003__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>
|
|
|