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_subnet01_0003"></a><a name="vpc_subnet01_0003"></a>
|
|
|
|
<h1 class="topictitle1">Querying Subnets</h1>
|
|
<div id="body2854726"><div class="section" id="vpc_subnet01_0003__section49967061"><h4 class="sectiontitle">Function</h4><p id="vpc_subnet01_0003__p29906272">This API is used to query subnets using search criteria and to display the subnets in a list.</p>
|
|
</div>
|
|
<div class="section" id="vpc_subnet01_0003__section47050372"><h4 class="sectiontitle">URI</h4><p id="vpc_subnet01_0003__p11347535134915">GET /v1/{project_id}/subnets</p>
|
|
<div class="p" id="vpc_subnet01_0003__p1161213844918">Example:<pre class="screen" id="vpc_subnet01_0003__screen32273037144016">GET https://{Endpoint}/v1/{project_id}/subnets?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85</pre>
|
|
</div>
|
|
<div class="p" id="vpc_subnet01_0003__p24474419496">
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnet01_0003__table42526340" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_subnet01_0003__row55636561"><th align="left" class="cellrowborder" valign="top" width="20.11201120112011%" id="mcps1.3.2.4.1.2.5.1.1"><p id="vpc_subnet01_0003__p10267631">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.04180418041804%" id="mcps1.3.2.4.1.2.5.1.2"><p id="vpc_subnet01_0003__p26371793">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.72137213721372%" id="mcps1.3.2.4.1.2.5.1.3"><p id="vpc_subnet01_0003__p6814361175820">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.12481248124813%" id="mcps1.3.2.4.1.2.5.1.4"><p id="vpc_subnet01_0003__p55740512">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_subnet01_0003__row18687619"><td class="cellrowborder" valign="top" width="20.11201120112011%" headers="mcps1.3.2.4.1.2.5.1.1 "><p id="vpc_subnet01_0003__p37302179">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.04180418041804%" headers="mcps1.3.2.4.1.2.5.1.2 "><p id="vpc_subnet01_0003__p1577639">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.72137213721372%" headers="mcps1.3.2.4.1.2.5.1.3 "><p id="vpc_subnet01_0003__p15092369175820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12481248124813%" headers="mcps1.3.2.4.1.2.5.1.4 "><p id="vpc_subnet01_0003__p10487112">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row9248440"><td class="cellrowborder" valign="top" width="20.11201120112011%" headers="mcps1.3.2.4.1.2.5.1.1 "><p id="vpc_subnet01_0003__p10926182">marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.04180418041804%" headers="mcps1.3.2.4.1.2.5.1.2 "><p id="vpc_subnet01_0003__p12605589">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.72137213721372%" headers="mcps1.3.2.4.1.2.5.1.3 "><p id="vpc_subnet01_0003__p14522390175820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12481248124813%" headers="mcps1.3.2.4.1.2.5.1.4 "><p id="vpc_subnet01_0003__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_subnet01_0003__p538818488578">This parameter can work together with the parameter <strong id="vpc_subnet01_0003__vpc_api01_0003_b650614119446">limit</strong>.</p>
|
|
<ul id="vpc_subnet01_0003__ul12704811125810"><li id="vpc_subnet01_0003__vpc_api01_0003_li325418407124">If parameters <strong id="vpc_subnet01_0003__vpc_api01_0003_b736582413514">marker</strong> and <strong id="vpc_subnet01_0003__vpc_api01_0003_b17435293518">limit</strong> are not passed, all resource records will be returned.</li><li id="vpc_subnet01_0003__vpc_api01_0003_li1923817171338">If the parameter <strong id="vpc_subnet01_0003__vpc_api01_0003_b1505159195414">marker</strong> is not passed and the value of parameter <strong id="vpc_subnet01_0003__vpc_api01_0003_b14146122925417">limit</strong> is set to <strong id="vpc_subnet01_0003__vpc_api01_0003_b13594516546">10</strong>, the first 10 resource records will be returned.</li><li id="vpc_subnet01_0003__vpc_api01_0003_li2076741203417">If the value of the parameter <strong id="vpc_subnet01_0003__vpc_api01_0003_b13589356163415">marker</strong> is set to the resource ID of the 10th record and the value of parameter <strong id="vpc_subnet01_0003__vpc_api01_0003_b1557415118357">limit</strong> is set to <strong id="vpc_subnet01_0003__vpc_api01_0003_b10574171193511">10</strong>, the 11th to 20th resource records will be returned.</li><li id="vpc_subnet01_0003__vpc_api01_0003_li108512113551">If the value of the parameter <strong id="vpc_subnet01_0003__vpc_api01_0003_b9403193716543">marker</strong> is set to the resource ID of the 10th record and the parameter <strong id="vpc_subnet01_0003__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_subnet01_0003__row43066942"><td class="cellrowborder" valign="top" width="20.11201120112011%" headers="mcps1.3.2.4.1.2.5.1.1 "><p id="vpc_subnet01_0003__p65870306">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.04180418041804%" headers="mcps1.3.2.4.1.2.5.1.2 "><p id="vpc_subnet01_0003__p33894570">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.72137213721372%" headers="mcps1.3.2.4.1.2.5.1.3 "><p id="vpc_subnet01_0003__p35462927175820">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12481248124813%" headers="mcps1.3.2.4.1.2.5.1.4 "><p id="vpc_subnet01_0003__p2017153116589">Specifies the number of records that will be returned on each page. The value is from 0 to intmax.</p>
|
|
<p id="vpc_subnet01_0003__p125192338584"><strong id="vpc_subnet01_0003__vpc_api01_0003_b7164124258">limit</strong> can be used together with <strong id="vpc_subnet01_0003__vpc_api01_0003_b15985310854">marker</strong>. For details, see the parameter description of <strong id="vpc_subnet01_0003__vpc_api01_0003_b193281854847">marker</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row4071301142654"><td class="cellrowborder" valign="top" width="20.11201120112011%" headers="mcps1.3.2.4.1.2.5.1.1 "><p id="vpc_subnet01_0003__p61339955142654">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.04180418041804%" headers="mcps1.3.2.4.1.2.5.1.2 "><p id="vpc_subnet01_0003__p2480462142654">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.72137213721372%" headers="mcps1.3.2.4.1.2.5.1.3 "><p id="vpc_subnet01_0003__p66699709142654">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.12481248124813%" headers="mcps1.3.2.4.1.2.5.1.4 "><p id="vpc_subnet01_0003__p2678389014283">Specifies that the VPC ID is used as the filtering condition.</p>
|
|
<p id="vpc_subnet01_0003__p13743141181413">This field is mandatory in the fine-grained authorization scenario based on enterprise projects.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_subnet01_0003__section20800170"><h4 class="sectiontitle">Request Message</h4><ul id="vpc_subnet01_0003__ul5903470"><li id="vpc_subnet01_0003__li8662426">Request parameter<p id="vpc_subnet01_0003__p51540969203856"><a name="vpc_subnet01_0003__li8662426"></a><a name="li8662426"></a>None</p>
|
|
</li><li id="vpc_subnet01_0003__li1037839394214">Example request<pre class="screen" id="vpc_subnet01_0003__screen5812133564510">GET https://{Endpoint}/v1/{project_id}/subnets</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_subnet01_0003__section52983808"><h4 class="sectiontitle">Response Message</h4><ul id="vpc_subnet01_0003__ul6675738"><li id="vpc_subnet01_0003__li34774863">Response parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnet01_0003__table162269121588" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_subnet01_0003__row95582811588"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpc_subnet01_0003__p360232861588">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.15%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpc_subnet01_0003__p584710571588">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.51%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpc_subnet01_0003__p385351831588">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_subnet01_0003__row343421581588"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpc_subnet01_0003__p302514461588">subnets</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.15%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpc_subnet01_0003__p26395826172022">Array of <a href="#vpc_subnet01_0003__table946390317596">subnet</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpc_subnet01_0003__p530125231588">Specifies the subnets.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_subnet01_0003__table946390317596"></a><a name="table946390317596"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnet01_0003__table946390317596" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_subnet01_0003__b3558758143713">subnet</strong> objects</caption><thead align="left"><tr id="vpc_subnet01_0003__row2260217717596"><th align="left" class="cellrowborder" valign="top" width="29.017098290170978%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpc_subnet01_0003__p1883706917596">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.6983301669833%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpc_subnet01_0003__p4259704317596">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.284571542845704%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpc_subnet01_0003__p2780847717596">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_subnet01_0003__row3789415517596"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p4952771817596">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p1023955317596">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p2409742517596">Specifies a resource ID in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row1555023417596"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p5160943617596">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p4529288117596">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_subnet01_0003__ul23311559134110"><li id="vpc_subnet01_0003__li10331195974115">Specifies the subnet name.</li><li id="vpc_subnet01_0003__li13332135944118">The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row6838204320315"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p541524553114">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p0415745133114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_subnet01_0003__ul237215542179"><li id="vpc_subnet01_0003__li19372754181713">Provides supplementary information about the subnet.</li><li id="vpc_subnet01_0003__li13372125412173">The value can contain no more than 255 characters and cannot contain angle brackets (< or >).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row94962917596"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p981112017596">cidr</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p1336165217596">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p855202117596">Specifies the subnet CIDR block.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row985932517596"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p6040786717596">gateway_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p5817993817596">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p1495452217596">Specifies the subnet gateway address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row37297117596"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p3021071917596">dhcp_enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p4005526017596">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p2325061317596">Specifies whether the DHCP function is enabled for the subnet.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row792892917596"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p3826349217596">primary_dns</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p5962058717596">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p6453823917596">Specifies the IP address of DNS server 1 on the subnet.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row4397324617596"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p506319417596">secondary_dns</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p73411217596">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p5946313017596">Specifies the IP address of DNS server 2 on the subnet.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row545834911143"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p591866701143">dnsList</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p318589811143">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p304407061143">Specifies the IP address list of DNS servers on the subnet.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row6540612517596"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p6340476417596">availability_zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p5792277317596">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p6123300617596">Identifies the AZ to which the subnet belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row1422614217596"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p1146682617596">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p481418517596">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p5440471517596">Specifies the ID of the VPC to which the subnet belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row1988039417596"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p6680804517596">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p3959872717596">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_subnet01_0003__ul1290083685410"><li id="vpc_subnet01_0003__li13201524194619">Specifies the status of the subnet.</li><li id="vpc_subnet01_0003__li18201524114619">The value can be <strong>ACTIVE</strong>, <strong>UNKNOWN</strong>, or <strong>ERROR</strong>.<ul id="vpc_subnet01_0003__ul83391032184614"><li id="vpc_subnet01_0003__li175681357183117"><strong id="vpc_subnet01_0003__b1282232355019">ACTIVE</strong>: indicates that the subnet has been associated with a VPC.</li><li id="vpc_subnet01_0003__li5568157103111"><strong id="vpc_subnet01_0003__b5558132585016">UNKNOWN</strong>: indicates that the subnet has not been associated with a VPC.</li><li id="vpc_subnet01_0003__li85681932326"><strong id="vpc_subnet01_0003__b842352706151734">ERROR</strong>: indicates that the subnet is abnormal.</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row6437766611027"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p2150517711033">neutron_network_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p3263900011033">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p2651330711033">Specifies the ID of the corresponding network (OpenStack Neutron API).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row2552805011031"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p84866711033">neutron_subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p6517899211033">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p4500696511033">Specifies the ID of the corresponding subnet (OpenStack Neutron API).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__row147527203715"><td class="cellrowborder" valign="top" width="29.017098290170978%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_subnet01_0003__p5714303263">extra_dhcp_opts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6983301669833%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_subnet01_0003__p01223042610">Array of <a href="#vpc_subnet01_0003__table019517383270">extra_dhcp_opt</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.284571542845704%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_subnet01_0003__p111573015263">Specifies the NTP server address configured for the subnet. For details, see <a href="#vpc_subnet01_0003__table019517383270">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_subnet01_0003__table019517383270"></a><a name="table019517383270"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnet01_0003__table019517383270" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_subnet01_0003__vpc_subnet01_0001_b842352706165741">extra_dhcp_opt</strong> object</caption><thead align="left"><tr id="vpc_subnet01_0003__vpc_subnet01_0001_row1806141418109"><th align="left" class="cellrowborder" valign="top" width="21.740000000000002%" id="mcps1.3.4.2.1.3.2.5.1.1"><p id="vpc_subnet01_0003__vpc_subnet01_0001_p1948182811017"><strong id="vpc_subnet01_0003__vpc_subnet01_0001_b842352706195711">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.17%" id="mcps1.3.4.2.1.3.2.5.1.2"><p id="vpc_subnet01_0003__vpc_subnet01_0001_p19515288107">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.619999999999997%" id="mcps1.3.4.2.1.3.2.5.1.3"><p id="vpc_subnet01_0003__vpc_subnet01_0001_p755202861014">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.47%" id="mcps1.3.4.2.1.3.2.5.1.4"><p id="vpc_subnet01_0003__vpc_subnet01_0001_p66018281105"><strong id="vpc_subnet01_0003__vpc_subnet01_0001_b1716215324573">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_subnet01_0003__vpc_subnet01_0001_row19806161420105"><td class="cellrowborder" valign="top" width="21.740000000000002%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="vpc_subnet01_0003__vpc_subnet01_0001_p1834323611017">opt_value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.17%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="vpc_subnet01_0003__vpc_subnet01_0001_p1034310368108">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.619999999999997%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="vpc_subnet01_0003__vpc_subnet01_0001_p15343163651014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.47%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><ul id="vpc_subnet01_0003__vpc_subnet01_0001_ul1734314363102"><li id="vpc_subnet01_0003__vpc_subnet01_0001_li2034343671010">Specifies the NTP server address configured for the subnet.</li><li id="vpc_subnet01_0003__vpc_subnet01_0001_li12343183661011">Constraints:<p id="vpc_subnet01_0003__vpc_subnet01_0001_p1984274292214"><a name="vpc_subnet01_0003__vpc_subnet01_0001_li12343183661011"></a><a name="vpc_subnet01_0001_li12343183661011"></a>The option <strong id="vpc_subnet01_0003__vpc_subnet01_0001_b18312174218176">ntp</strong> for <strong id="vpc_subnet01_0003__vpc_subnet01_0001_b2456833191713">opt_name</strong> indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option <strong id="vpc_subnet01_0003__vpc_subnet01_0001_b1973813315213">null</strong> for <strong id="vpc_subnet01_0003__vpc_subnet01_0001_b9368121819213">opt_name</strong> indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_subnet01_0003__vpc_subnet01_0001_row48061714191011"><td class="cellrowborder" valign="top" width="21.740000000000002%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="vpc_subnet01_0003__vpc_subnet01_0001_p33437363104">opt_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.17%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="vpc_subnet01_0003__vpc_subnet01_0001_p1634393613106">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.619999999999997%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="vpc_subnet01_0003__vpc_subnet01_0001_p14343113613104">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.47%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><ul id="vpc_subnet01_0003__vpc_subnet01_0001_ul1934353641010"><li id="vpc_subnet01_0003__vpc_subnet01_0001_li1534373631020">Specifies the NTP server address name configured for the subnet.</li><li id="vpc_subnet01_0003__vpc_subnet01_0001_li11343133651014">Currently, the value can only be set to <strong id="vpc_subnet01_0003__vpc_subnet01_0001_b185618261310">ntp</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="vpc_subnet01_0003__li2265872194229">Example response<pre class="screen" id="vpc_subnet01_0003__screen50654438144051">{
|
|
"subnets": [
|
|
{
|
|
"id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
|
|
"name": "subnet",
|
|
"cidr": "192.168.20.0/24",
|
|
"dnsList": [
|
|
"114.xx.xx.114",
|
|
"114.xx.xx.115"
|
|
],
|
|
"status": "ACTIVE",
|
|
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
|
|
"gateway_ip": "192.168.20.1",
|
|
"dhcp_enable": true,
|
|
"primary_dns": "114.xx.xx.114",
|
|
"secondary_dns": "114.xx.xx.115",
|
|
"availability_zone": "aa-bb-cc",//For example, the AZ is <em id="vpc_subnet01_0003__i10794520183113">aa-bb-cc</em>.
|
|
"neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
|
|
"neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12"
|
|
"extra_dhcp_opts": [
|
|
{
|
|
"opt_value": "10.100.0.33,10.100.0.34",
|
|
"opt_name": "ntp"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "531dec0f-3116-411b-a21b-e612e42349fd",
|
|
"name": "Subnet1",
|
|
"description": "",
|
|
"cidr": "192.168.1.0/24",
|
|
"dnsList": [
|
|
"114.xx.xx.114",
|
|
"114.xx.xx.115"
|
|
],
|
|
"status": "ACTIVE",
|
|
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
|
|
"gateway_ip": "192.168.1.1",
|
|
"dhcp_enable": true,
|
|
"primary_dns": "114.xx.xx.114",
|
|
"secondary_dns": "114.xx.xx.115",
|
|
"availability_zone": "aa-bb-cc",//For example, the AZ is <em id="vpc_subnet01_0003__i1971422193118">aa-bb-cc</em>.
|
|
"neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd",
|
|
"neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78",
|
|
"extra_dhcp_opts": [
|
|
{
|
|
"opt_value": "10.100.0.33,10.100.0.34",
|
|
"opt_name": "ntp"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_subnet01_0003__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_subnet01_0003__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_subnet01_0003__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_subnet01_0003__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_subnet01_0000.html">Subnet</a></div>
|
|
</div>
|
|
</div>
|
|
|