vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpc/api-ref/vpc_subnetpools_0001.html
gtema 4cfecba474 VPC api from PR#278 
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>
2022-10-17 12:39:05 +00:00

352 lines
28 KiB
HTML
Raw Blame History

<a name="vpc_subnetpools_0001"></a><a name="vpc_subnetpools_0001"></a>
<h1 class="topictitle1">Creating a Subnet Pool</h1>
<div id="body1515565658182"><div class="section" id="vpc_subnetpools_0001__section54540374"><h4 class="sectiontitle">Function</h4><p id="vpc_subnetpools_0001__p57902635">This API is used to create a subnet pool.</p>
</div>
<div class="section" id="vpc_subnetpools_0001__section21101319"><h4 class="sectiontitle">URI</h4><p id="vpc_subnetpools_0001__p9937185751713">POST /v2.0/subnetpools</p>
</div>
<div class="section" id="vpc_subnetpools_0001__section31485239"><h4 class="sectiontitle">Request Message</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnetpools_0001__table26517876" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="vpc_subnetpools_0001__row40476817"><th align="left" class="cellrowborder" valign="top" width="22.509999999999998%" id="mcps1.3.3.2.2.5.1.1"><p id="vpc_subnetpools_0001__p57396781">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.700000000000001%" id="mcps1.3.3.2.2.5.1.2"><p id="vpc_subnetpools_0001__p18627652">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.3.2.2.5.1.3"><p id="vpc_subnetpools_0001__p32444864">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.44%" id="mcps1.3.3.2.2.5.1.4"><p id="vpc_subnetpools_0001__p10788361">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnetpools_0001__row1442054"><td class="cellrowborder" valign="top" width="22.509999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="vpc_subnetpools_0001__p49697568">subnetpool</p>
</td>
<td class="cellrowborder" valign="top" width="13.700000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="vpc_subnetpools_0001__p66080062"><a href="vpc_subnetpools_0001.html">subnetpool </a>object</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.3.2.2.5.1.3 "><p id="vpc_subnetpools_0001__p50884809">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="41.44%" headers="mcps1.3.3.2.2.5.1.4 "><p id="vpc_subnetpools_0001__p19248251">Specifies the subnet pool list. For details, see <a href="#vpc_subnetpools_0001__table12211980105515">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_subnetpools_0001__table12211980105515"></a><a name="table12211980105515"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnetpools_0001__table12211980105515" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="vpc_subnetpools_0001__b1429511462371">subnetpool</strong> objects</caption><thead align="left"><tr id="vpc_subnetpools_0001__row32722637105515"><th align="left" class="cellrowborder" valign="top" width="24.86%" id="mcps1.3.3.3.2.5.1.1"><p id="vpc_subnetpools_0001__p60075710105815"><strong id="vpc_subnetpools_0001__b136971748143716">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.13%" id="mcps1.3.3.3.2.5.1.2"><p id="vpc_subnetpools_0001__p15964952144115"><strong id="vpc_subnetpools_0001__b204001849173713">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.86%" id="mcps1.3.3.3.2.5.1.3"><p id="vpc_subnetpools_0001__p34294369105815"><strong id="vpc_subnetpools_0001__b10280450153713">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="38.15%" id="mcps1.3.3.3.2.5.1.4"><p id="vpc_subnetpools_0001__p25203839105815"><strong id="vpc_subnetpools_0001__b593745043711">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnetpools_0001__row43081158105515"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0001__p54833166105624">name</p>
</td>
<td class="cellrowborder" valign="top" width="12.13%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_subnetpools_0001__p179641252184115">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0001__p12301465105624">String</p>
</td>
<td class="cellrowborder" valign="top" width="38.15%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0001__p14797472105624">Specifies the subnet pool name.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row49397935105515"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0001__p23027912105624">default_quota</p>
</td>
<td class="cellrowborder" valign="top" width="12.13%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_subnetpools_0001__p7964152134116">No</p>
</td>
<td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0001__p6099296144650">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="38.15%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0001__p2365807714488">Specifies the upper limit of the prefix space that can be allocated from the subnet pool to the subnet. For IPv4 subnet pools, <strong id="vpc_subnetpools_0001__b79730412384">default_quota</strong> is measured in units of /32. For IPv6 subnet pools, <strong id="vpc_subnetpools_0001__b66892447381">default_quota</strong> is measured in units of /64.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row62757710105647"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0001__p5097986810577">prefixes</p>
</td>
<td class="cellrowborder" valign="top" width="12.13%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_subnetpools_0001__p139641652184112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0001__p118841747111416">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="38.15%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0001__p1242857210116">Specifies a list of subnet prefixes that are assigned to the subnet pool. The adjacent prefixes are merged and treated as a single prefix. Each subnet prefix must be unique.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row2545218105647"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0001__p1395064410577">min_prefixlen</p>
</td>
<td class="cellrowborder" valign="top" width="12.13%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_subnetpools_0001__p7964552174112">No</p>
</td>
<td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0001__p5626034310577">Integer</p>
<p id="vpc_subnetpools_0001__p3658104710577"></p>
</td>
<td class="cellrowborder" valign="top" width="38.15%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0001__p3725182415446">Specifies the minimum number for the prefix of a subnet that can be allocated from the subnet pool. The minimum number for the prefix of an IPv4 subnet is <strong id="vpc_subnetpools_0001__b6518740174312">8</strong>, and that of an IPv6 subnet is <strong id="vpc_subnetpools_0001__b23391158154319">64</strong>.</p>
<p id="vpc_subnetpools_0001__p37814568346">Instructions:</p>
<p id="vpc_subnetpools_0001__p15995203519">min_prefixlen =&lt; default_prefixlen =&lt; max_prefixlen</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row21625046105653"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0001__p4495318510577">default_prefixlen</p>
</td>
<td class="cellrowborder" valign="top" width="12.13%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_subnetpools_0001__p39641652114112">No</p>
</td>
<td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0001__p1732939410577">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="38.15%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0001__p5482176910577">Specifies the default prefix to be allocated to a subnet if the <strong id="vpc_subnetpools_0001__b15232819164210">cidr</strong> or <strong id="vpc_subnetpools_0001__b162716224424">prefixlen</strong> is not specified when you create the subnet. The default value is <strong id="vpc_subnetpools_0001__b157011449114210">8</strong> for an IPv4 subnet and <strong id="vpc_subnetpools_0001__b194581852104212">64</strong> for an IPv6 subnet.</p>
<p id="vpc_subnetpools_0001__p195431012103514">Instructions:</p>
<p id="vpc_subnetpools_0001__p45431512133516">min_prefixlen =&lt; default_prefixlen =&lt; max_prefixlen</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row18053024151048"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0001__p53008854151048">max_prefixlen</p>
</td>
<td class="cellrowborder" valign="top" width="12.13%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_subnetpools_0001__p1796525214415">No</p>
</td>
<td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0001__p65858788151048">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="38.15%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0001__p14908979151048">Specifies the maximum number for the prefix of a subnet that can be allocated from the subnet pool. The maximum number for the prefix of an IPv4 subnet is <strong id="vpc_subnetpools_0001__b84709217467">32</strong>, and that of an IPv6 subnet is <strong id="vpc_subnetpools_0001__b18471520468">128</strong>.</p>
<p id="vpc_subnetpools_0001__p757517149356">Instructions:</p>
<p id="vpc_subnetpools_0001__p135753142358">min_prefixlen =&lt; default_prefixlen =&lt; max_prefixlen</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row8351286151053"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0001__p5365552151053">description</p>
</td>
<td class="cellrowborder" valign="top" width="12.13%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_subnetpools_0001__p129651752124116">No</p>
</td>
<td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0001__p31956587151053">String</p>
</td>
<td class="cellrowborder" valign="top" width="38.15%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0001__p28387452151053">Provides supplementary information about the subnet pool.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row3921595115167"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0001__p2237545215167">is_default</p>
</td>
<td class="cellrowborder" valign="top" width="12.13%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_subnetpools_0001__p89651952104117">No</p>
</td>
<td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0001__p47230515167">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="38.15%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0001__p4334828415167">Specifies whether this is the default subnet pool.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row21006459151647"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0001__p23801595151647">revision_number</p>
</td>
<td class="cellrowborder" valign="top" width="12.13%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_subnetpools_0001__p10965195219417">No</p>
</td>
<td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0001__p48881052151647">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="38.15%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0001__p59981829151647">Specifies the revision number of the subnet pool.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_subnetpools_0001__section14931696"><h4 class="sectiontitle">Response Message</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnetpools_0001__table31929956" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter</caption><thead align="left"><tr id="vpc_subnetpools_0001__row12454319"><th align="left" class="cellrowborder" valign="top" width="23.810000000000002%" id="mcps1.3.4.2.2.4.1.1"><p id="vpc_subnetpools_0001__p2166929">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.89%" id="mcps1.3.4.2.2.4.1.2"><p id="vpc_subnetpools_0001__p41303584">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.3%" id="mcps1.3.4.2.2.4.1.3"><p id="vpc_subnetpools_0001__p7224675">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnetpools_0001__row48327783"><td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.4.1.1 "><p id="vpc_subnetpools_0001__p22236344">subnetpool</p>
</td>
<td class="cellrowborder" valign="top" width="19.89%" headers="mcps1.3.4.2.2.4.1.2 "><p id="vpc_subnetpools_0001__p56313405"><a href="#vpc_subnetpools_0001__table149662441462">subnetpool </a>object</p>
</td>
<td class="cellrowborder" valign="top" width="56.3%" headers="mcps1.3.4.2.2.4.1.3 "><p id="vpc_subnetpools_0001__p37955333">Specifies the subnet pool list. For details, see <a href="#vpc_subnetpools_0001__table149662441462">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_subnetpools_0001__table149662441462"></a><a name="table149662441462"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnetpools_0001__table149662441462" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_subnetpools_0001__b4471650185413">subnetpool</strong> objects</caption><thead align="left"><tr id="vpc_subnetpools_0001__row496617442612"><th align="left" class="cellrowborder" valign="top" width="28.29%" id="mcps1.3.4.3.2.4.1.1"><p id="vpc_subnetpools_0001__p1596613445611"><strong id="vpc_subnetpools_0001__b137320516546">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.29%" id="mcps1.3.4.3.2.4.1.2"><p id="vpc_subnetpools_0001__p49667449616"><strong id="vpc_subnetpools_0001__b131642052205413">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.419999999999995%" id="mcps1.3.4.3.2.4.1.3"><p id="vpc_subnetpools_0001__p8966144413616"><strong id="vpc_subnetpools_0001__b1594318521541">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnetpools_0001__row28303131105515"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p2014344105614">id</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p28944191105614">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p53796361105614">Specifies the subnet pool ID.</p>
<p id="vpc_subnetpools_0001__p1089535311426">This parameter is not mandatory when you query subnet pools.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row1196634410618"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p696615445611">name</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p3966104412620">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p89666442613">Specifies the subnet pool name.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row9772661105515"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p49939441105624">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p18562940105624">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p682749310257">Specifies the IP address version.</p>
<p id="vpc_subnetpools_0001__p33352482102727">Supported versions: IPv4 and IPv6</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row89665441569"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p79664442613">default_quota</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p496616449616">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p7968244361">Specifies the upper limit of the prefix space that can be allocated from the subnet pool to the subnet. For IPv4 subnet pools, <strong id="vpc_subnetpools_0001__b54432924410">default_quota</strong> is measured in units of /32. For IPv6 subnet pools, <strong id="vpc_subnetpools_0001__b9444189134414">default_quota</strong> is measured in units of /64.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row157121839115912"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p870051413911">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p15700614790">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row2067783695917"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p11508184345913">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p1651534311599">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p552334314592">Specifies the time (UTC) when the subnet pool is created.</p>
<p id="vpc_subnetpools_0001__p65980291419">Format: <em id="vpc_subnetpools_0001__i134613016619">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row1428916334597"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p15531114325914">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p853513432597">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p1954364325913">Specifies the time (UTC) when the subnet pool rule is updated.</p>
<p id="vpc_subnetpools_0001__p04198487169">Format: <em id="vpc_subnetpools_0001__i103381752814">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row1796820448610"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p296834417616">prefixes</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p209681244961">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p1496884418618">Specifies a list of subnet prefixes that are assigned to the subnet pool. The adjacent prefixes are merged and treated as a single prefix. Each subnet prefix must be unique.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row14968744267"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p199681944763">min_prefixlen</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p49682044566">Integer</p>
<p id="vpc_subnetpools_0001__p896894413611"></p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p397084410616">Specifies the minimum number for the prefix of a subnet that can be allocated from the subnet pool. The minimum number for the prefix of an IPv4 subnet is <strong id="vpc_subnetpools_0001__b47863357449">8</strong>, and that of an IPv6 subnet is <strong id="vpc_subnetpools_0001__b1978613514446">64</strong>.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row22360302105653"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p1404384110577">address_scope_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p930111615640">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p2924364410577">Specifies the ID of the address range allocated to the subnet pool.</p>
<p id="vpc_subnetpools_0001__p62544866102532">Only the administrator can specify this attribute.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row1597013444615"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p19970184415616">shared</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p597044417614">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p159708444612">Specifies whether the network can be shared to all projects. </p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row99704441966"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p3970744162">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p597014415620">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p534413014313">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row139702441463"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p4970154418614">default_prefixlen</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p397018441063">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p3970044567">Specifies the default prefix to be allocated to a subnet if the <strong id="vpc_subnetpools_0001__b1927315891118">cidr</strong> or <strong id="vpc_subnetpools_0001__b1427975813113">prefixlen</strong> is not specified when you create the subnet. The default value is <strong id="vpc_subnetpools_0001__b188754851218">8</strong> for an IPv4 subnet and <strong id="vpc_subnetpools_0001__b12887114851218">64</strong> for an IPv6 subnet.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row197118445620"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p1297110441967">max_prefixlen</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p697184412610">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p497164414613">Specifies the maximum number for the prefix of a subnet that can be allocated from the subnet pool. The maximum number for the prefix of an IPv4 subnet is <strong id="vpc_subnetpools_0001__b1580555118448">32</strong>, and that of an IPv6 subnet is <strong id="vpc_subnetpools_0001__b2805105174416">128</strong>.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row1597174413610"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p397114441268">description</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p5971104410613">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p097164411616">Provides supplementary information about the subnet pool.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row129712441610"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p1971174417613">is_default</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p1597254413618">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p17972114418620">Specifies whether this is the default subnet pool.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row129724441264"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p12972144415618">revision_number</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p179721944765">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p19724441061">Specifies the revision number of the subnet pool.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0001__row1157812085820"><td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0001__p6578142025814">tags</p>
</td>
<td class="cellrowborder" valign="top" width="28.29%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0001__p1847018315584">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0001__p10578120125815">Specifies the tags.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_subnetpools_0001__section38241653113834"><h4 class="sectiontitle">Example:</h4><div class="p" id="vpc_subnetpools_0001__p16164310122019">Example request<pre class="screen" id="vpc_subnetpools_0001__screen25274267114129">POST https://{Endpoint}/v2.0/subnetpools
{
"subnetpool": {
"name": "my-subnet-pool",
"prefixes": [
"192.168.0.0/16",
"10.10.0.0/21"
],
"default_prefixlen": 25,
"min_prefixlen": 24,
"max_prefixlen": 30,
"shared": false
}
}</pre>
</div>
</div>
<p id="vpc_subnetpools_0001__p8376417142012">Example response</p>
<pre class="screen" id="vpc_subnetpools_0001__screen56767275154929">{
"subnetpool": {
"address_scope_id": null,
"default_prefixlen": 25,
"default_quota": null,
"description": "",
"id": "f49a1319-423a-4ee6-ba54-1d95a4f6cc68",
"ip_version": 4,
"is_default": false,
"max_prefixlen": 30,
"min_prefixlen": 24,
"name": "my-subnet-pool",
"prefixes": [
"10.10.0.0/21",
"192.168.0.0/16"
],
"project_id": "9fadcee8aa7c40cdb2114fff7d569c08",
"revision_number": 1,
"shared": false,
"tenant_id": "9fadcee8aa7c40cdb2114fff7d569c08",
"created_at": "2018-09-20T02:15:34",
"updated_at": "2018-09-20T02:15:34",
"tags": []
}
}</pre>
<div class="section" id="vpc_subnetpools_0001__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_subnetpools_0001__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="vpc_subnetpools_0001__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_subnetpools_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_subnetpools_0000.html">Subnet Pool</a></div>
</div>
</div>
View Git Blame Copy Permalink