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>
305 lines
26 KiB
HTML
305 lines
26 KiB
HTML
<a name="vpc_api01_0004"></a><a name="vpc_api01_0004"></a>
|
|
|
|
<h1 class="topictitle1">Updating VPC Information</h1>
|
|
<div id="body3738651"><div class="section" id="vpc_api01_0004__section8079634"><h4 class="sectiontitle">Function</h4><p id="vpc_api01_0004__p34395333">This API is used to update information about a VPC.</p>
|
|
</div>
|
|
<div class="section" id="vpc_api01_0004__section5607849"><h4 class="sectiontitle">URI</h4><p id="vpc_api01_0004__p10571920181615">PUT /v1/{project_id}/vpcs/{vpc_id}</p>
|
|
<div class="p" id="vpc_api01_0004__p174525125223"><a href="#vpc_api01_0004__table27380479">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="vpc_api01_0004__table27380479"></a><a name="table27380479"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_api01_0004__table27380479" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_api01_0004__row28751554"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpc_api01_0004__p47174532">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.2"><p id="vpc_api01_0004__p63040734">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.3"><p id="vpc_api01_0004__p6025849">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_api01_0004__row18331773"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpc_api01_0004__p8478608">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpc_api01_0004__p15678685">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpc_api01_0004__p10487112">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row21254748"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpc_api01_0004__p43913021">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpc_api01_0004__p184914">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpc_api01_0004__p14978051">Specifies the VPC ID, which uniquely identifies the VPC.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_api01_0004__section50470647"><h4 class="sectiontitle">Request Message</h4><ul id="vpc_api01_0004__ul5262650"><li id="vpc_api01_0004__li11266626">Request parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_api01_0004__table4060745715545" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="vpc_api01_0004__row1619435515545"><th align="left" class="cellrowborder" valign="top" width="11.459999999999999%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="vpc_api01_0004__p3667439915545">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.93%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="vpc_api01_0004__p1783637615545">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.93%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="vpc_api01_0004__p3546035715545">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.68%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="vpc_api01_0004__p5371668715545">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_api01_0004__row5608438115545"><td class="cellrowborder" valign="top" width="11.459999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpc_api01_0004__p4654101615545">vpc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpc_api01_0004__p1172592715545">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.93%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpc_api01_0004__p1027601915545"><a href="#vpc_api01_0004__table34290771">vpc</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.68%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpc_api01_0004__p4213394815545"><a href="#vpc_api01_0004__table34290771">Specifies the VPC objects.</a></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="p" id="vpc_api01_0004__p5740662215545">
|
|
<div class="tablenoborder"><a name="vpc_api01_0004__table34290771"></a><a name="table34290771"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_api01_0004__table34290771" frame="border" border="1" rules="all"><caption><b>Table 3 </b>VPC objects</caption><thead align="left"><tr id="vpc_api01_0004__row42952388"><th align="left" class="cellrowborder" valign="top" width="14.66%" id="mcps1.3.3.2.1.2.1.2.5.1.1"><p id="vpc_api01_0004__p56591389">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.16%" id="mcps1.3.3.2.1.2.1.2.5.1.2"><p id="vpc_api01_0004__p20499795">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.849999999999998%" id="mcps1.3.3.2.1.2.1.2.5.1.3"><p id="vpc_api01_0004__p17479484174639">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.33%" id="mcps1.3.3.2.1.2.1.2.5.1.4"><p id="vpc_api01_0004__p49870669">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_api01_0004__row12992371"><td class="cellrowborder" valign="top" width="14.66%" headers="mcps1.3.3.2.1.2.1.2.5.1.1 "><p id="vpc_api01_0004__p45749167">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.3.2.1.2.1.2.5.1.2 "><p id="vpc_api01_0004__p14695014">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.849999999999998%" headers="mcps1.3.3.2.1.2.1.2.5.1.3 "><p id="vpc_api01_0004__p6552131174639">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.33%" headers="mcps1.3.3.2.1.2.1.2.5.1.4 "><ul id="vpc_api01_0004__ul0576257538"><li id="vpc_api01_0004__li65761585314">Specifies the VPC name.</li><li id="vpc_api01_0004__li1257655195317">The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li><li id="vpc_api01_0004__li185761505317">Each VPC name of a tenant must be unique if the VPC name is not left blank.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row12304154151511"><td class="cellrowborder" valign="top" width="14.66%" headers="mcps1.3.3.2.1.2.1.2.5.1.1 "><p id="vpc_api01_0004__p211618568154">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.3.2.1.2.1.2.5.1.2 "><p id="vpc_api01_0004__p1211635651520">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.849999999999998%" headers="mcps1.3.3.2.1.2.1.2.5.1.3 "><p id="vpc_api01_0004__p18116165611152">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.33%" headers="mcps1.3.3.2.1.2.1.2.5.1.4 "><ul id="vpc_api01_0004__ul5116195661518"><li id="vpc_api01_0004__li111164567152">Provides supplementary information about the VPC.</li><li id="vpc_api01_0004__li1511612560159">The value can contain no more than 255 characters and cannot contain angle brackets (< or >).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row7722248"><td class="cellrowborder" valign="top" width="14.66%" headers="mcps1.3.3.2.1.2.1.2.5.1.1 "><p id="vpc_api01_0004__p21522370">cidr</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.3.2.1.2.1.2.5.1.2 "><p id="vpc_api01_0004__p65590400">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.849999999999998%" headers="mcps1.3.3.2.1.2.1.2.5.1.3 "><p id="vpc_api01_0004__p60960565174639">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.33%" headers="mcps1.3.3.2.1.2.1.2.5.1.4 "><ul id="vpc_api01_0004__ul161253336536"><li id="vpc_api01_0004__li1389739194615">Specifies the available IP address ranges for subnets in the VPC.</li><li id="vpc_api01_0004__li10294123376">Possible values are as follows:<ul id="vpc_api01_0004__vpc_api01_0001_ul53161626155413"><li id="vpc_api01_0004__vpc_api01_0001_li19197628192317">10.0.0.0/8-24</li><li id="vpc_api01_0004__vpc_api01_0001_li181981528172314">172.16.0.0/12-24</li><li id="vpc_api01_0004__vpc_api01_0001_li191981628122312">192.168.0.0/16-24</li></ul>
|
|
</li><li id="vpc_api01_0004__li898228181014">If <strong id="vpc_api01_0004__b3560145617710">cidr</strong> is not specified, the default value is left blank.</li><li id="vpc_api01_0004__li138920394463">The value must be in CIDR format, for example, <strong id="vpc_api01_0004__b082517582076">192.168.0.0/16</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row1151401882715"><td class="cellrowborder" valign="top" width="14.66%" headers="mcps1.3.3.2.1.2.1.2.5.1.1 "><p id="vpc_api01_0004__p1470522022711">routes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.3.2.1.2.1.2.5.1.2 "><p id="vpc_api01_0004__p770572018273">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.849999999999998%" headers="mcps1.3.3.2.1.2.1.2.5.1.3 "><p id="vpc_api01_0004__p570519208272">Array of <a href="#vpc_api01_0004__table1696324019336">route</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.33%" headers="mcps1.3.3.2.1.2.1.2.5.1.4 "><ul id="vpc_api01_0004__ul13320192141811"><li id="vpc_api01_0004__li1932014241811">Specifies the route list. For details, see <a href="#vpc_api01_0004__table1696324019336">Table 4</a>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row14946201923916"><td class="cellrowborder" valign="top" width="14.66%" headers="mcps1.3.3.2.1.2.1.2.5.1.1 "><p id="vpc_api01_0004__p41373254402">enable_shared_snat</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.3.2.1.2.1.2.5.1.2 "><p id="vpc_api01_0004__p2036962673916">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.849999999999998%" headers="mcps1.3.3.2.1.2.1.2.5.1.3 "><p id="vpc_api01_0004__p18137202516409">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.33%" headers="mcps1.3.3.2.1.2.1.2.5.1.4 "><p id="vpc_api01_0004__p51371325174011">Specifies whether the shared SNAT function is enabled. The value <strong id="vpc_api01_0004__b84235270612178">true</strong> indicates that the function is enabled, and the value <strong id="vpc_api01_0004__b84235270614243">false</strong> indicates that the function is not enabled.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_api01_0004__table1696324019336"></a><a name="table1696324019336"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_api01_0004__table1696324019336" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_api01_0004__b814711358115">route</strong> objects</caption><thead align="left"><tr id="vpc_api01_0004__vpc_api01_0004_row921218691556"><th align="left" class="cellrowborder" valign="top" width="15.110000000000001%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="vpc_api01_0004__vpc_api01_0004_p798956991556">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.85%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="vpc_api01_0004__p63244160226">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.530000000000001%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="vpc_api01_0004__vpc_api01_0004_p754435891556">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.51%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="vpc_api01_0004__vpc_api01_0004_p711326791556">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_api01_0004__vpc_api01_0004_row3930377391556"><td class="cellrowborder" valign="top" width="15.110000000000001%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="vpc_api01_0004__vpc_api01_0004_p2948903591556">destination</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.85%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="vpc_api01_0004__p032471662214">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.530000000000001%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="vpc_api01_0004__vpc_api01_0004_p270722191556">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.51%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><ul id="vpc_api01_0004__vpc_api01_0004_ul18181132710558"><li id="vpc_api01_0004__vpc_api01_0004_li16181127135511">Specifies the destination network segment of a route.</li><li id="vpc_api01_0004__vpc_api01_0004_li81812027185513">The value must be in the CIDR format. Currently, only the value <strong>0.0.0.0/0</strong> is supported.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__vpc_api01_0004_row6565233911054"><td class="cellrowborder" valign="top" width="15.110000000000001%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="vpc_api01_0004__vpc_api01_0004_p1623922311054">nexthop</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.85%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="vpc_api01_0004__p93241416202213">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.530000000000001%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="vpc_api01_0004__vpc_api01_0004_p4377761311054">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.51%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><ul id="vpc_api01_0004__vpc_api01_0004_ul17731193025515"><li id="vpc_api01_0004__vpc_api01_0004_li173123010550">Specifies the next hop of a route.</li><li id="vpc_api01_0004__vpc_api01_0004_li27311030165517">The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="vpc_api01_0004__li4942146994044">Example request<pre class="screen" id="vpc_api01_0004__screen34198396143727">PUT https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3
|
|
|
|
{
|
|
"vpc": {
|
|
"name": "vpc1",
|
|
"description": "test1",
|
|
"cidr": "192.168.0.0/16",
|
|
"enable_shared_snat": true
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_api01_0004__section51582645"><h4 class="sectiontitle">Response Message</h4><ul id="vpc_api01_0004__ul26290551"><li id="vpc_api01_0004__li39785747">Response parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_api01_0004__table163236181565" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameter</caption><thead align="left"><tr id="vpc_api01_0004__row361709001565"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpc_api01_0004__p441618021565">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.729999999999997%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpc_api01_0004__p366208391565">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.93%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpc_api01_0004__p134980151565">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_api01_0004__row195974151565"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpc_api01_0004__p438867591565">vpc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.729999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpc_api01_0004__p440032491565"><a href="#vpc_api01_0004__table22527411">vpc</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.93%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpc_api01_0004__p3322021565"><a href="#vpc_api01_0004__table22527411">Specifies the VPC objects.</a></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_api01_0004__table22527411"></a><a name="table22527411"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_api01_0004__table22527411" frame="border" border="1" rules="all"><caption><b>Table 6 </b>VPC objects</caption><thead align="left"><tr id="vpc_api01_0004__row37318421"><th align="left" class="cellrowborder" valign="top" width="17.59175917591759%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpc_api01_0004__p2893298">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.822182218221823%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpc_api01_0004__p32078086174724">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60.58605860586058%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpc_api01_0004__p58230900">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_api01_0004__row19082474"><td class="cellrowborder" valign="top" width="17.59175917591759%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_api01_0004__p2176568">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.822182218221823%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_api01_0004__p48188187174724">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.58605860586058%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_api01_0004__p53389951">Specifies a resource ID in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row10747513"><td class="cellrowborder" valign="top" width="17.59175917591759%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_api01_0004__p65242240">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.822182218221823%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_api01_0004__p10929060174724">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.58605860586058%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_api01_0004__p47359816174719">Specifies the VPC name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row15698184911617"><td class="cellrowborder" valign="top" width="17.59175917591759%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_api01_0004__p174335514162">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.822182218221823%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_api01_0004__p743345115166">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.58605860586058%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_api01_0004__ul6433175110169"><li id="vpc_api01_0004__li1243395117167">Provides supplementary information about the VPC.</li><li id="vpc_api01_0004__li124331151101616">The value can contain no more than 255 characters and cannot contain angle brackets (< or >).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row37632913"><td class="cellrowborder" valign="top" width="17.59175917591759%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_api01_0004__p28367147">cidr</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.822182218221823%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_api01_0004__p12838666174724">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.58605860586058%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_api01_0004__ul10389173917465"><li id="vpc_api01_0004__li998711418180">Specifies the available IP address ranges for subnets in the VPC.</li><li id="vpc_api01_0004__li64603833312">Possible values are as follows:<ul id="vpc_api01_0004__vpc_api01_0001_ul53161626155413_1"><li id="vpc_api01_0004__vpc_api01_0001_li19197628192317_1">10.0.0.0/8-24</li><li id="vpc_api01_0004__vpc_api01_0001_li181981528172314_1">172.16.0.0/12-24</li><li id="vpc_api01_0004__vpc_api01_0001_li191981628122312_1">192.168.0.0/16-24</li></ul>
|
|
</li><li id="vpc_api01_0004__li12987144121819">If <strong id="vpc_api01_0004__b32921160817">cidr</strong> is not specified, the default value is left blank.</li><li id="vpc_api01_0004__li18987949184">The value must be in CIDR format, for example, <strong id="vpc_api01_0004__b13607171818814">192.168.0.0/16</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row14466778"><td class="cellrowborder" valign="top" width="17.59175917591759%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_api01_0004__p30958352">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.822182218221823%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_api01_0004__p33298996174724">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.58605860586058%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_api01_0004__ul74552213513"><li id="vpc_api01_0004__li54552219516">Specifies the VPC status.</li><li id="vpc_api01_0004__li1638165285418">Possible values are as follows:<ul id="vpc_api01_0004__ul5890854165417"><li id="vpc_api01_0004__li1065610385510"><strong id="vpc_api01_0004__b3219648483">CREATING</strong>: The VPC is being created.</li><li id="vpc_api01_0004__li1545513255116"><strong id="vpc_api01_0004__b32161149686">OK</strong>: The VPC is created successfully.</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row824411301996"><td class="cellrowborder" valign="top" width="17.59175917591759%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_api01_0004__p11990421917">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.822182218221823%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_api01_0004__p119917421894">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.58605860586058%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_api01_0004__ul04621553135413"><li id="vpc_api01_0004__li194621653165412">Specifies the enterprise project ID.</li><li id="vpc_api01_0004__li18462195318544">The value is <strong id="vpc_api01_0004__b2292184819368">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value <strong id="vpc_api01_0004__b2012012527366">0</strong> indicates the default enterprise project.</li></ul>
|
|
<div class="note" id="vpc_api01_0004__note19041412125118"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpc_api01_0004__vpc_api01_0001_p182751511487">This parameter is unsupported. Do not use it.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row6192167813568"><td class="cellrowborder" valign="top" width="17.59175917591759%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_api01_0004__p4960003413568">routes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.822182218221823%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_api01_0004__p1494185813568">Array of <a href="#vpc_api01_0004__table3576833291556">route</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.58605860586058%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_api01_0004__ul1021319485513"><li id="vpc_api01_0004__li5213104145511">Specifies the route information.</li><li id="vpc_api01_0004__li1421310411556">For details, see the description of the <a href="#vpc_api01_0004__table3576833291556">route objects</a>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row197011819164016"><td class="cellrowborder" valign="top" width="17.59175917591759%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_api01_0004__p2819122014403">enable_shared_snat</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.822182218221823%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_api01_0004__p19821620144010">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.58605860586058%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_api01_0004__p2082432034020">Specifies whether the shared SNAT function is enabled. The value <strong id="vpc_api01_0004__b331426189">true</strong> indicates that the function is enabled, and the value <strong id="vpc_api01_0004__b2001892536">false</strong> indicates that the function is not enabled.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_api01_0004__table3576833291556"></a><a name="table3576833291556"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_api01_0004__table3576833291556" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="vpc_api01_0004__b63120291109">route</strong> objects</caption><thead align="left"><tr id="vpc_api01_0004__row921218691556"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="vpc_api01_0004__p798956991556">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.38%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="vpc_api01_0004__p754435891556">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.28%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="vpc_api01_0004__p711326791556">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_api01_0004__row3930377391556"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpc_api01_0004__p2948903591556">destination</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.38%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpc_api01_0004__p270722191556">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.28%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><ul id="vpc_api01_0004__ul18181132710558"><li id="vpc_api01_0004__li16181127135511">Specifies the destination network segment of a route.</li><li id="vpc_api01_0004__li81812027185513">The value must be in the CIDR format. Currently, only the value <strong>0.0.0.0/0</strong> is supported.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_api01_0004__row6565233911054"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpc_api01_0004__p1623922311054">nexthop</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.38%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpc_api01_0004__p4377761311054">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.28%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><ul id="vpc_api01_0004__ul17731193025515"><li id="vpc_api01_0004__li173123010550">Specifies the next hop of a route.</li><li id="vpc_api01_0004__li27311030165517">The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="vpc_api01_0004__li2186983094052">Example response<pre class="screen" id="vpc_api01_0004__screen2181268143749">{
|
|
"vpc": {
|
|
"id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
|
|
"name": "vpc1",
|
|
"description": "test1",
|
|
"cidr": "192.168.0.0/16",
|
|
"status": "OK",
|
|
"enterprise_project_id": "0",
|
|
"routes": [],
|
|
"enable_shared_snat": true
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_api01_0004__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_api01_0004__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_api01_0004__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_api01_0004__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_api01_0000.html">Virtual Private Cloud</a></div>
|
|
</div>
|
|
</div>
|
|
|