vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpc/api-ref/vpc_subnet02_0001.html
Qin Ying, Fan 310d2d9eb1 VPC API 20230106 version 
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>
2024-02-06 08:38:37 +00:00

472 lines
39 KiB
HTML
Raw Blame History

<a name="vpc_subnet02_0001"></a><a name="vpc_subnet02_0001"></a>
<h1 class="topictitle1">Querying Subnets</h1>
<div id="body1496890183069"><div class="section" id="vpc_subnet02_0001__section47928120"><h4 class="sectiontitle">Function</h4><p id="vpc_subnet02_0001__p159719161716">This API is used to query all subnets accessible to the tenant submitting the request. </p>
</div>
<div class="section" id="vpc_subnet02_0001__section28699899"><h4 class="sectiontitle">URI</h4><p id="vpc_subnet02_0001__p88020775">GET /v2.0/subnets</p>
<p id="vpc_subnet02_0001__p1386393372916">Example:</p>
<pre class="screen" id="vpc_subnet02_0001__screen1986319335297">GET https://{Endpoint}/v2.0/subnets?name={subnet_name}&amp;ip_version={ip_version}&amp;network_id={network_id}&amp;cidr={subnet_cidr_address}&amp;gateway_ip={subnet_gateway}&amp;tenant_id={tenant_id}&amp;enable_dhcp={is_enable_dhcp}</pre>
<p id="vpc_subnet02_0001__p18857932205418">Example of querying networks by page</p>
<pre class="screen" id="vpc_subnet02_0001__screen6349039695144">GET https://{Endpoint}/v2.0/subnets?limit=2&amp;marker=011fc878-5521-4654-a1ad-f5b0b5820302&amp;page_reverse=False</pre>
</div>
<p id="vpc_subnet02_0001__p52055413147"><a href="#vpc_subnet02_0001__table3825412149">Table 1</a> describes the parameters.</p>
<div class="tablenoborder"><a name="vpc_subnet02_0001__table3825412149"></a><a name="table3825412149"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnet02_0001__table3825412149" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_subnet02_0001__row72051741191419"><th align="left" class="cellrowborder" valign="top" width="17.091709170917092%" id="mcps1.3.4.2.5.1.1"><p id="vpc_subnet02_0001__p11205114113148"><strong id="vpc_subnet02_0001__b820313302017">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.271927192719275%" id="mcps1.3.4.2.5.1.2"><p id="vpc_subnet02_0001__p1205124171417"><strong id="vpc_subnet02_0001__b98531533801">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.63166316631663%" id="mcps1.3.4.2.5.1.3"><p id="vpc_subnet02_0001__p4205124191411"><strong id="vpc_subnet02_0001__b162142035502">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.004700470047%" id="mcps1.3.4.2.5.1.4"><p id="vpc_subnet02_0001__p3205144151413"><strong id="vpc_subnet02_0001__b20283936204">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnet02_0001__row8205041111418"><td class="cellrowborder" valign="top" width="17.091709170917092%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_subnet02_0001__p92051641151419">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.271927192719275%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_subnet02_0001__p220544113147">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.63166316631663%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_subnet02_0001__p162059412145">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.004700470047%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_subnet02_0001__p1205841111418">Specifies that the ID is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row192054417143"><td class="cellrowborder" valign="top" width="17.091709170917092%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_subnet02_0001__p620694131411">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.271927192719275%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_subnet02_0001__p820619412149">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.63166316631663%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_subnet02_0001__p18206114120146">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.004700470047%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_subnet02_0001__p920612418149">Specifies that the subnet name is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row520664131419"><td class="cellrowborder" valign="top" width="17.091709170917092%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_subnet02_0001__p1206441191420">enable_dhcp</p>
</td>
<td class="cellrowborder" valign="top" width="19.271927192719275%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_subnet02_0001__p16206104131414">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.63166316631663%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_subnet02_0001__p1206104119142">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="47.004700470047%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_subnet02_0001__p144291518141512">Specifies whether DHCP is enabled for the subnet is used as the filtering condition.</p>
<p id="vpc_subnet02_0001__p142063410146">The value can be <strong id="vpc_subnet02_0001__b3420201714115">true</strong> or <strong id="vpc_subnet02_0001__b842061715118">false</strong>.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row4206441171415"><td class="cellrowborder" valign="top" width="17.091709170917092%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_subnet02_0001__p4206174161415">cidr</p>
</td>
<td class="cellrowborder" valign="top" width="19.271927192719275%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_subnet02_0001__p16206104111145">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.63166316631663%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_subnet02_0001__p0206541121416">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.004700470047%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_subnet02_0001__p3206164161418">Specifies that the CIDR block is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row720664119147"><td class="cellrowborder" valign="top" width="17.091709170917092%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_subnet02_0001__p120684191415">network_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.271927192719275%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_subnet02_0001__p020604117141">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.63166316631663%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_subnet02_0001__p10206204131416">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.004700470047%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_subnet02_0001__p192061641131415">Specifies that the network ID is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row1120614111148"><td class="cellrowborder" valign="top" width="17.091709170917092%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_subnet02_0001__p13206641111413">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="19.271927192719275%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_subnet02_0001__p14206154181414">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.63166316631663%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_subnet02_0001__p11206184161418">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.004700470047%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_subnet02_0001__p17206134120140">Specifies that the IP address version is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row122065416145"><td class="cellrowborder" valign="top" width="17.091709170917092%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_subnet02_0001__p16206114181418">gateway_ip</p>
</td>
<td class="cellrowborder" valign="top" width="19.271927192719275%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_subnet02_0001__p11206941191418">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.63166316631663%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_subnet02_0001__p6206141191413">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.004700470047%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_subnet02_0001__p92061741171417">Specifies that the gateway IP address is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row10206174112140"><td class="cellrowborder" valign="top" width="17.091709170917092%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_subnet02_0001__p420620416149">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.271927192719275%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_subnet02_0001__p1620612416148">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.63166316631663%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_subnet02_0001__p1420620410148">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.004700470047%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_subnet02_0001__p72071941181420">Specifies that the project ID is used as the filtering condition.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row1720744110145"><td class="cellrowborder" valign="top" width="17.091709170917092%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_subnet02_0001__p112071541201414">marker</p>
</td>
<td class="cellrowborder" valign="top" width="19.271927192719275%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_subnet02_0001__p7207841141412">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.63166316631663%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_subnet02_0001__p1207114117140">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.004700470047%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_subnet02_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_subnet02_0001__p538818488578">This parameter can work together with the parameter <strong id="vpc_subnet02_0001__vpc_api01_0003_b650614119446">limit</strong>.</p>
<ul id="vpc_subnet02_0001__ul12704811125810"><li id="vpc_subnet02_0001__vpc_api01_0003_li325418407124">If parameters <strong id="vpc_subnet02_0001__vpc_api01_0003_b736582413514">marker</strong> and <strong id="vpc_subnet02_0001__vpc_api01_0003_b17435293518">limit</strong> are not passed, resource records on the first page will be returned.</li><li id="vpc_subnet02_0001__vpc_api01_0003_li1923817171338">If the parameter <strong id="vpc_subnet02_0001__vpc_api01_0003_b1505159195414">marker</strong> is not passed and the value of parameter <strong id="vpc_subnet02_0001__vpc_api01_0003_b14146122925417">limit</strong> is set to <strong id="vpc_subnet02_0001__vpc_api01_0003_b13594516546">10</strong>, the first 10 resource records will be returned.</li><li id="vpc_subnet02_0001__vpc_api01_0003_li2076741203417">If the value of the parameter <strong id="vpc_subnet02_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_subnet02_0001__vpc_api01_0003_b1557415118357">limit</strong> is set to <strong id="vpc_subnet02_0001__vpc_api01_0003_b10574171193511">10</strong>, the 11th to 20th resource records will be returned.</li><li id="vpc_subnet02_0001__vpc_api01_0003_li108512113551">If the value of the parameter <strong id="vpc_subnet02_0001__vpc_api01_0003_b9403193716543">marker</strong> is set to the resource ID of the 10th record and the parameter <strong id="vpc_subnet02_0001__vpc_api01_0003_b10358823165519">limit</strong> is not passed, resource records starting from the 11th records (including 11th) will be returned.</li></ul>
</td>
</tr>
<tr id="vpc_subnet02_0001__row220774110141"><td class="cellrowborder" valign="top" width="17.091709170917092%" headers="mcps1.3.4.2.5.1.1 "><p id="vpc_subnet02_0001__p82075416148">limit</p>
</td>
<td class="cellrowborder" valign="top" width="19.271927192719275%" headers="mcps1.3.4.2.5.1.2 "><p id="vpc_subnet02_0001__p1720714413143">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.63166316631663%" headers="mcps1.3.4.2.5.1.3 "><p id="vpc_subnet02_0001__p1620714117148">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="47.004700470047%" headers="mcps1.3.4.2.5.1.4 "><p id="vpc_subnet02_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_subnet02_0001__p125192338584"><strong id="vpc_subnet02_0001__vpc_api01_0003_b7164124258">limit</strong> can be used together with <strong id="vpc_subnet02_0001__vpc_api01_0003_b15985310854">marker</strong>. For details, see the parameter description of <strong id="vpc_subnet02_0001__vpc_api01_0003_b193281854847">marker</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="vpc_subnet02_0001__section42990474"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_subnet02_0001__p4775574">None</p>
</div>
<div class="section" id="vpc_subnet02_0001__section76068222298"><h4 class="sectiontitle">Example Request</h4><p id="vpc_subnet02_0001__p1435042532915">Example 1</p>
<pre class="screen" id="vpc_subnet02_0001__screen4331621113015">GET https://{Endpoint}/v2.0/subnets?limit=1</pre>
<p id="vpc_subnet02_0001__p1544113015299">Example 2</p>
<pre class="screen" id="vpc_subnet02_0001__screen869293113306">GET https://{Endpoint}/v2.0/subnets?id=011fc878-5521-4654-a1ad-f5b0b5820322</pre>
</div>
<div class="section" id="vpc_subnet02_0001__section51369953"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnet02_0001__table51277242" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_subnet02_0001__row64740644"><th align="left" class="cellrowborder" valign="top" width="23.122312231223123%" id="mcps1.3.7.2.2.4.1.1"><p id="vpc_subnet02_0001__p9500791">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.552555255525554%" id="mcps1.3.7.2.2.4.1.2"><p id="vpc_subnet02_0001__p31366578">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.325132513251326%" id="mcps1.3.7.2.2.4.1.3"><p id="vpc_subnet02_0001__p40344834">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnet02_0001__row46706151"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.7.2.2.4.1.1 "><p id="vpc_subnet02_0001__p25101909">subnets</p>
</td>
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.7.2.2.4.1.2 "><p id="vpc_subnet02_0001__p21426146239">Array of <a href="#vpc_subnet02_0001__table176735992713">subnet</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.7.2.2.4.1.3 "><p id="vpc_subnet02_0001__p15291872">Specifies the subnet list. For details, see <a href="#vpc_subnet02_0001__table176735992713">Table 3</a>.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row9988173210387"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.7.2.2.4.1.1 "><p id="vpc_subnet02_0001__p12599163715385">subnets_links</p>
</td>
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.7.2.2.4.1.2 "><p id="vpc_subnet02_0001__p9599173717383">Array of <a href="#vpc_subnet02_0001__table10817112933915">subnets_link</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.7.2.2.4.1.3 "><p id="vpc_subnet02_0001__p155991337143818">Specifies the pagination information. For details, see <a href="#vpc_subnet02_0001__table10817112933915">Table 6</a>.</p>
<p id="vpc_subnet02_0001__p334511413543">Only when <strong id="vpc_subnet02_0001__b8497481911">limit</strong> is used for filtering and the number of resources exceeds the value of <strong id="vpc_subnet02_0001__b4727453898">limit</strong> or 2000 (default value of <strong id="vpc_subnet02_0001__b6283125620911">limit</strong>), value <strong id="vpc_subnet02_0001__b8134132191017">next</strong> will be returned for <strong id="vpc_subnet02_0001__b206056414102">rel</strong> and a link for <strong id="vpc_subnet02_0001__b18973136101014">href</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_subnet02_0001__table176735992713"></a><a name="table176735992713"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnet02_0001__table176735992713" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_subnet02_0001__b78791142162711">subnet</strong> objects</caption><thead align="left"><tr id="vpc_subnet02_0001__row176713593276"><th align="left" class="cellrowborder" valign="top" width="28.332833283328334%" id="mcps1.3.7.3.2.4.1.1"><p id="vpc_subnet02_0001__p136755912715"><strong id="vpc_subnet02_0001__b18205124462718">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.292829282928288%" id="mcps1.3.7.3.2.4.1.2"><p id="vpc_subnet02_0001__p667105912718"><strong id="vpc_subnet02_0001__b14231124510275">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.37433743374337%" id="mcps1.3.7.3.2.4.1.3"><p id="vpc_subnet02_0001__p26855915275"><strong id="vpc_subnet02_0001__b22102046192715">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnet02_0001__row28303131105515"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p2014344105614">id</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p28944191105614">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p53796361105614">Specifies the subnet ID.</p>
<p id="vpc_subnet02_0001__p2677113954519">This parameter is not mandatory when you query subnets.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row1868135972719"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p37015595272">name</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p18706591271">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p1870259172715">Specifies the subnet name.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row670165910271"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p187012596279">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p137095922720">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p870155932715">Specifies the IP address version.</p>
<p id="vpc_subnet02_0001__p10708598273">The value can be <strong id="vpc_subnet02_0001__b10194133216418">4</strong> (IPv4) or <strong id="vpc_subnet02_0001__b165604341844">6</strong> (IPv6).</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row1270135915274"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p1770105919271">ipv6_address_mode</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p1370205912279">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p5701759142713">Specifies the IPv6 addressing mode.</p>
<p id="vpc_subnet02_0001__p167055910273">Only <strong id="vpc_subnet02_0001__b155761630195112">dhcpv6-stateful</strong> is supported.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row57075913279"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p070195972715">ipv6_ra_mode</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p1970559102716">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p19701959152712">Specifies the IPv6 route broadcast mode.</p>
<p id="vpc_subnet02_0001__p1270185982712">Only <strong id="vpc_subnet02_0001__b27667222">dhcpv6-stateful</strong> is supported.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row970185911274"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p5719599271">network_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p1671105982710">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p1071259102716">Specifies the ID of the network to which the subnet belongs.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row9711659142718"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p1471155922712">cidr</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p1871155912279">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p471115972720">Specifies the CIDR format.</p>
<p id="vpc_subnet02_0001__p9638641211">Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row373659122718"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p173195914274">gateway_ip</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p16733594272">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p167319597276">The gateway IP address cannot conflict with IP addresses configured for <strong id="vpc_subnet02_0001__b842352706101449">allocation_pools</strong>.</p>
<p id="vpc_subnet02_0001__p1773175918271">This attribute cannot be modified. </p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row6733598278"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p37325918273">allocation_pools</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p166911588244">Array of <a href="#vpc_subnet02_0001__table1777145918276">allocation_pool</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p13740597271">Specifies available IP address pools. For details, see <a href="#vpc_subnet02_0001__table1777145918276">Table 4</a>.</p>
<p id="vpc_subnet02_0001__p137415915279">Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ]</p>
<p id="vpc_subnet02_0001__p377419371346">The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system.</p>
<p id="vpc_subnet02_0001__p14178729172918">[{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}]</p>
<p id="vpc_subnet02_0001__p15322181416320">In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system.</p>
<p id="vpc_subnet02_0001__p167414592279">By default, the IP addresses reserved by the system are not in the IP address pool specified by <strong id="vpc_subnet02_0001__b842352706121042">allocation_pool</strong>.</p>
<p id="vpc_subnet02_0001__p074359192720">When updating an IP address pool, the <strong id="vpc_subnet02_0001__b280215131523">allocation_pool</strong> value can contain neither gateway nor broadcast IP addresses. </p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row474205911270"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p774105972720">dns_nameservers</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p1474155952710">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p10743593273">Specifies the DNS server address.</p>
<p id="vpc_subnet02_0001__p97485912712">Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"]</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row6741659182714"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p574959122713">host_routes</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p18246193118245">Array of <a href="#vpc_subnet02_0001__table177865912715">host_route</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p2074459132712">Specifies the static VM routes. For details, see <a href="#vpc_subnet02_0001__table177865912715">Table 5</a>.</p>
<p id="vpc_subnet02_0001__p1674359172717">Static routes are not supported, and entered information will be ignored.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row42017779105653"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p5182838910577">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p3734998010577">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row97535914274"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p475959202718">enable_dhcp</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p2755596279">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p47595962710">Specifies whether to enable the DHCP function. Value <strong id="vpc_subnet02_0001__b842352706155341">false</strong> indicates that the DHCP function is not enabled.</p>
<p id="vpc_subnet02_0001__p57535914276">The value can only be <strong id="vpc_subnet02_0001__b193171228153711">true</strong>.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row5751059162715"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p976659192718">use_default_subnetpool</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p27655942716">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p20761598272">Specifies whether the default address pool is used.</p>
<p id="vpc_subnet02_0001__p127625920276">The value can be set to <strong id="vpc_subnet02_0001__b37202937615141">true</strong> only when IPv6 is used.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row13831193312316"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p1711142512596">subnetpool_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p511425115919">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p211132512598">Specifies the subnet pool ID.</p>
<p id="vpc_subnet02_0001__p345014515117">Currently, only IPv6 is supported.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row63315321123"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p870051413911">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p45641422124917">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p113781259182412">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row126291040191211"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p1953114119914">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p595318416919">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p1395374115919">Specifies the time (UTC) when the subnet is created.</p>
<p id="vpc_subnet02_0001__p65980291419">Format: <em id="vpc_subnet02_0001__i1328416545374">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row1084513362123"><td class="cellrowborder" valign="top" width="28.332833283328334%" headers="mcps1.3.7.3.2.4.1.1 "><p id="vpc_subnet02_0001__p139719548912">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="28.292829282928288%" headers="mcps1.3.7.3.2.4.1.2 "><p id="vpc_subnet02_0001__p53971154594">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37433743374337%" headers="mcps1.3.7.3.2.4.1.3 "><p id="vpc_subnet02_0001__p1339713549918">Specifies the time (UTC) when the subnet is updated.</p>
<p id="vpc_subnet02_0001__p10406183916467">Format: <em id="vpc_subnet02_0001__i11061673819">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_subnet02_0001__table1777145918276"></a><a name="table1777145918276"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnet02_0001__table1777145918276" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_subnet02_0001__b842352706155352">allocation_pool</strong> objects</caption><thead align="left"><tr id="vpc_subnet02_0001__row11772597275"><th align="left" class="cellrowborder" valign="top" width="23.65%" id="mcps1.3.7.4.2.4.1.1"><p id="vpc_subnet02_0001__p1477155962713"><strong id="vpc_subnet02_0001__b88338814011">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.610000000000003%" id="mcps1.3.7.4.2.4.1.2"><p id="vpc_subnet02_0001__p1077859162717"><strong id="vpc_subnet02_0001__b18138164613815">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.739999999999995%" id="mcps1.3.7.4.2.4.1.3"><p id="vpc_subnet02_0001__p5771159182718"><strong id="vpc_subnet02_0001__b227245419189">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnet02_0001__row167785982711"><td class="cellrowborder" valign="top" width="23.65%" headers="mcps1.3.7.4.2.4.1.1 "><p id="vpc_subnet02_0001__p1077159182720">start</p>
</td>
<td class="cellrowborder" valign="top" width="24.610000000000003%" headers="mcps1.3.7.4.2.4.1.2 "><p id="vpc_subnet02_0001__p2077125912718">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.739999999999995%" headers="mcps1.3.7.4.2.4.1.3 "><p id="vpc_subnet02_0001__p2078205910275">Specifies the start IP address of a network pool.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row1782594271"><td class="cellrowborder" valign="top" width="23.65%" headers="mcps1.3.7.4.2.4.1.1 "><p id="vpc_subnet02_0001__p9781459162717">end</p>
</td>
<td class="cellrowborder" valign="top" width="24.610000000000003%" headers="mcps1.3.7.4.2.4.1.2 "><p id="vpc_subnet02_0001__p1778115952719">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.739999999999995%" headers="mcps1.3.7.4.2.4.1.3 "><p id="vpc_subnet02_0001__p187825911271">Specifies the end IP address of a network pool.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_subnet02_0001__table177865912715"></a><a name="table177865912715"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnet02_0001__table177865912715" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="vpc_subnet02_0001__b842352706155428">host_route</strong> objects</caption><thead align="left"><tr id="vpc_subnet02_0001__row1779145992719"><th align="left" class="cellrowborder" valign="top" width="23.712371237123715%" id="mcps1.3.7.5.2.4.1.1"><p id="vpc_subnet02_0001__p2794593271"><strong id="vpc_subnet02_0001__b11963213911">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.4024402440244%" id="mcps1.3.7.5.2.4.1.2"><p id="vpc_subnet02_0001__p14791594271"><strong id="vpc_subnet02_0001__b1048518314398">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.88518851885189%" id="mcps1.3.7.5.2.4.1.3"><p id="vpc_subnet02_0001__p14791459172716"><strong id="vpc_subnet02_0001__b1562165912187">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnet02_0001__row1379165919277"><td class="cellrowborder" valign="top" width="23.712371237123715%" headers="mcps1.3.7.5.2.4.1.1 "><p id="vpc_subnet02_0001__p979165972710">destination</p>
</td>
<td class="cellrowborder" valign="top" width="24.4024402440244%" headers="mcps1.3.7.5.2.4.1.2 "><p id="vpc_subnet02_0001__p37995952710">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.88518851885189%" headers="mcps1.3.7.5.2.4.1.3 "><p id="vpc_subnet02_0001__p10791559172714">Specifies the destination subnet of a route.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row1779185915279"><td class="cellrowborder" valign="top" width="23.712371237123715%" headers="mcps1.3.7.5.2.4.1.1 "><p id="vpc_subnet02_0001__p6791359102719">nexthop</p>
</td>
<td class="cellrowborder" valign="top" width="24.4024402440244%" headers="mcps1.3.7.5.2.4.1.2 "><p id="vpc_subnet02_0001__p107935942717">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.88518851885189%" headers="mcps1.3.7.5.2.4.1.3 "><p id="vpc_subnet02_0001__p87975920278">Specifies the next-hop IP address of a route.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_subnet02_0001__table10817112933915"></a><a name="table10817112933915"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnet02_0001__table10817112933915" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="vpc_subnet02_0001__b125484171710">subnets_link</strong> object</caption><thead align="left"><tr id="vpc_subnet02_0001__row988812911394"><th align="left" class="cellrowborder" valign="top" width="14.14%" id="mcps1.3.7.6.2.4.1.1"><p id="vpc_subnet02_0001__p2888112916394"><strong id="vpc_subnet02_0001__b168601438114519">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.14%" id="mcps1.3.7.6.2.4.1.2"><p id="vpc_subnet02_0001__p488802911392"><strong id="vpc_subnet02_0001__b900355234">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71.72%" id="mcps1.3.7.6.2.4.1.3"><p id="vpc_subnet02_0001__p68883299394"><strong id="vpc_subnet02_0001__b182312502204">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnet02_0001__row0888172913919"><td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.7.6.2.4.1.1 "><p id="vpc_subnet02_0001__p18888162993911">href</p>
</td>
<td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.7.6.2.4.1.2 "><p id="vpc_subnet02_0001__p1888842943911">String</p>
</td>
<td class="cellrowborder" valign="top" width="71.72%" headers="mcps1.3.7.6.2.4.1.3 "><p id="vpc_subnet02_0001__p88882295396">Specifies the API link.</p>
</td>
</tr>
<tr id="vpc_subnet02_0001__row4888172913395"><td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.7.6.2.4.1.1 "><p id="vpc_subnet02_0001__p1288872918396">rel</p>
</td>
<td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.7.6.2.4.1.2 "><p id="vpc_subnet02_0001__p1889929143911">String</p>
</td>
<td class="cellrowborder" valign="top" width="71.72%" headers="mcps1.3.7.6.2.4.1.3 "><p id="vpc_subnet02_0001__p48899296394">Specifies the relationship between the API link and the API version.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_subnet02_0001__section64320104111236"><h4 class="sectiontitle">Example Response</h4><p id="vpc_subnet02_0001__p162156577309">Example 1</p>
<pre class="screen" id="vpc_subnet02_0001__screen377810110469">{
"subnets": [
{
"name": "kesmdemeet",
"cidr": "172.16.236.0/24",
"id": "011fc878-5521-4654-a1ad-f5b0b5820302",
"enable_dhcp": true,
"network_id": "48efad0c-079d-4cc8-ace0-dce35d584124",
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"dns_nameservers": [],
"allocation_pools": [
{
"start": "172.16.236.2",
"end": "172.16.236.251"
}
],
"host_routes": [],
"ip_version": 4,
"gateway_ip": "172.16.236.1",
"created_at": "2018-03-26T08:23:43",
"updated_at": "2018-03-26T08:23:44"
}
],
"subnets_links": [
{
"rel": "next",
"href": "https://{Endpoint}/v2.0/subnets?limit=1&amp;marker=011fc878-5521-4654-a1ad-f5b0b5820302"
},
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/subnets?limit=1&amp;marker=011fc878-5521-4654-a1ad-f5b0b5820302&amp;page_reverse=True"
}
]
}</pre>
</div>
<p id="vpc_subnet02_0001__p6399133613216"></p>
<div class="p" id="vpc_subnet02_0001__p31883335613">Example 2<pre class="screen" id="vpc_subnet02_0001__screen16181333135611">{
"subnets": [
{
"id": "011fc878-5521-4654-a1ad-f5b0b5820322",
"name": "elb_alpha_vpc0_subnet0_172_16_0_0_24",
"tenant_id": "0c55e5b2b100d5202ff6c01a2fac4580",
"network_id": "3053b502-11b2-4599-bcf4-d9d06b6118b2",
"ip_version": 6,
"cidr": "2001:db8:a583:a0::/64",
"subnetpool_id": "cb03d100-8687-4c0a-9441-ea568dcae47d",
"allocation_pools": [{
"start": "2001:db8:a583:a0::2",
"end": "2001:db8:a583:a0:ffff:ffff:ffff:fffc"
}],
"gateway_ip": "2001:db8:a583:a0::1",
"enable_dhcp": true,
"ipv6_ra_mode": "dhcpv6-stateful",
"ipv6_address_mode": "dhcpv6-stateful",
"description": "",
"dns_nameservers": [],
"host_routes": [],
"project_id": "0c55e5b2b100d5202ff6c01a2fac4580",
"created_at": "2021-07-01T07:59:28",
"updated_at": "2021-07-01T07:59:28"
}
],
"subnets_links": [
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/subnets?limit=1&amp;id=011fc878-5521-4654-a1ad-f5b0b5820322&amp;marker=011fc878-5521-4654-a1ad-f5b0b5820302&amp;page_reverse=True"
}
]
}</pre>
</div>
<div class="section" id="vpc_subnet02_0001__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_subnet02_0001__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="vpc_subnet02_0001__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_subnet02_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_subnet02_0000.html">Subnet</a></div>
</div>
</div>
View Git Blame Copy Permalink