vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpc/api-ref/vpc_subnetpools_0004.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

334 lines
26 KiB
HTML
Raw Blame History

<a name="vpc_subnetpools_0004"></a><a name="vpc_subnetpools_0004"></a>
<h1 class="topictitle1">Updating a Subnet Pool</h1>
<div id="body1515565658182"><div class="section" id="vpc_subnetpools_0004__section10267951"><h4 class="sectiontitle">Function</h4><p id="vpc_subnetpools_0004__p15526968">This API is used to update a subnet pool.</p>
</div>
<div class="section" id="vpc_subnetpools_0004__section25302698"><h4 class="sectiontitle">URI</h4><p id="vpc_subnetpools_0004__p3121556192920">PUT /v2.0/subnetpools/{subnetpool_id}</p>
</div>
<div class="section" id="vpc_subnetpools_0004__section36252627"><h4 class="sectiontitle">Request Message</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnetpools_0004__table40701910" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="vpc_subnetpools_0004__row5914937"><th align="left" class="cellrowborder" valign="top" width="14.29%" id="mcps1.3.3.2.2.5.1.1"><p id="vpc_subnetpools_0004__p9347893">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="8.16%" id="mcps1.3.3.2.2.5.1.2"><p id="vpc_subnetpools_0004__p18981865">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.2%" id="mcps1.3.3.2.2.5.1.3"><p id="vpc_subnetpools_0004__p61136126">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.35%" id="mcps1.3.3.2.2.5.1.4"><p id="vpc_subnetpools_0004__p53079196">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnetpools_0004__row4447594"><td class="cellrowborder" valign="top" width="14.29%" headers="mcps1.3.3.2.2.5.1.1 "><p id="vpc_subnetpools_0004__p24710800">subnetpool</p>
</td>
<td class="cellrowborder" valign="top" width="8.16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="vpc_subnetpools_0004__p55417783"><a href="#vpc_subnetpools_0004__table149662441462">subnetpool</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="10.2%" headers="mcps1.3.3.2.2.5.1.3 "><p id="vpc_subnetpools_0004__p59655430">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="67.35%" headers="mcps1.3.3.2.2.5.1.4 "><p id="vpc_subnetpools_0004__p37955333">Specifies the subnet pool list. For details, see <a href="#vpc_subnetpools_0004__table12211980105515">Table 2</a>.</p>
<p id="vpc_subnetpools_0004__p2265180">You must specify at least one attribute when updating the subnet pool.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_subnetpools_0004__table12211980105515"></a><a name="table12211980105515"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnetpools_0004__table12211980105515" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="vpc_subnetpools_0004__b842352706211028">subnetpool</strong> objects</caption><thead align="left"><tr id="vpc_subnetpools_0004__row32722637105515"><th align="left" class="cellrowborder" valign="top" width="24.86%" id="mcps1.3.3.3.2.5.1.1"><p id="vpc_subnetpools_0004__p60075710105815"><strong id="vpc_subnetpools_0004__b117161146205610">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_0004__p15964952144115"><strong id="vpc_subnetpools_0004__b161051427113710">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.389999999999999%" id="mcps1.3.3.3.2.5.1.3"><p id="vpc_subnetpools_0004__p34294369105815"><strong id="vpc_subnetpools_0004__b2469232133717">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.62%" id="mcps1.3.3.3.2.5.1.4"><p id="vpc_subnetpools_0004__p25203839105815"><strong id="vpc_subnetpools_0004__b143311033103718">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnetpools_0004__row43081158105515"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0004__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_0004__p179641252184115">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0004__p12301465105624">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.62%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0004__p14797472105624">Specifies the subnet pool name.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row49397935105515"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0004__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_0004__p7964152134116">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0004__p6099296144650">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.62%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0004__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_0004__b5673124914460">default_quota</strong> is measured in units of /32. For IPv6 subnet pools, <strong id="vpc_subnetpools_0004__b5673124974613">default_quota</strong> is measured in units of /64.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row62757710105647"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0004__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_0004__p139641652184112">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0004__p3572863210577">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="49.62%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0004__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_0004__row2545218105647"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0004__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_0004__p7964552174112">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0004__p5626034310577">Integer</p>
<p id="vpc_subnetpools_0004__p3658104710577"></p>
</td>
<td class="cellrowborder" valign="top" width="49.62%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0004__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_0004__b05316314712">8</strong>, and that of an IPv6 subnet is <strong id="vpc_subnetpools_0004__b453619364712">64</strong>. Instructions:</p>
<p id="vpc_subnetpools_0004__p793283773517">min_prefixlen =&lt; default_prefixlen =&lt; max_prefixlen</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row21625046105653"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0004__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_0004__p39641652114112">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0004__p1732939410577">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.62%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0004__p5482176910577">Specifies the default prefix to be allocated to a subnet if the <strong id="vpc_subnetpools_0004__b2191255221">cidr</strong> or <strong id="vpc_subnetpools_0004__b219713515228">prefixlen</strong> is not specified when you create the subnet. The default value is <strong id="vpc_subnetpools_0004__b14577121011224">8</strong> for an IPv4 subnet and <strong id="vpc_subnetpools_0004__b15782010132219">64</strong> for an IPv6 subnet.</p>
<p id="vpc_subnetpools_0004__p37814568346">Instructions:</p>
<p id="vpc_subnetpools_0004__p15995203519">min_prefixlen =&lt; default_prefixlen =&lt; max_prefixlen</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row18053024151048"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0004__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_0004__p1796525214415">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0004__p65858788151048">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.62%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0004__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_0004__b1677841474715">32</strong>, and that of an IPv6 subnet is <strong id="vpc_subnetpools_0004__b1777891417472">128</strong>.</p>
<p id="vpc_subnetpools_0004__p179716319354">Instructions:</p>
<p id="vpc_subnetpools_0004__p979793119358">min_prefixlen =&lt; default_prefixlen =&lt; max_prefixlen</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row8351286151053"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0004__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_0004__p129651752124116">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0004__p31956587151053">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.62%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0004__p28387452151053">Provides supplementary information about the subnet pool.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row3921595115167"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_subnetpools_0004__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_0004__p89651952104117">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.389999999999999%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_subnetpools_0004__p47230515167">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="49.62%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_subnetpools_0004__p4334828415167">Specifies whether this is the default subnet pool.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_subnetpools_0004__section57838187"><h4 class="sectiontitle">Response Message</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnetpools_0004__table49261880" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter</caption><thead align="left"><tr id="vpc_subnetpools_0004__row31386613"><th align="left" class="cellrowborder" valign="top" width="31.7%" id="mcps1.3.4.2.2.4.1.1"><p id="vpc_subnetpools_0004__p59287744">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.080000000000002%" id="mcps1.3.4.2.2.4.1.2"><p id="vpc_subnetpools_0004__p37577972">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.22%" id="mcps1.3.4.2.2.4.1.3"><p id="vpc_subnetpools_0004__p58217140">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnetpools_0004__row17967889"><td class="cellrowborder" valign="top" width="31.7%" headers="mcps1.3.4.2.2.4.1.1 "><p id="vpc_subnetpools_0004__p46112886">subnetpool</p>
</td>
<td class="cellrowborder" valign="top" width="17.080000000000002%" headers="mcps1.3.4.2.2.4.1.2 "><p id="vpc_subnetpools_0004__p44156300"><a href="#vpc_subnetpools_0004__table149662441462">subnetpool</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.2.2.4.1.3 "><p id="vpc_subnetpools_0004__p522217">Specifies the subnet pool list. For details, see <a href="#vpc_subnetpools_0004__table149662441462">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_subnetpools_0004__table149662441462"></a><a name="table149662441462"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_subnetpools_0004__table149662441462" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_subnetpools_0004__b11151132184016">subnetpool</strong> objects</caption><thead align="left"><tr id="vpc_subnetpools_0004__row496617442612"><th align="left" class="cellrowborder" valign="top" width="24.33%" id="mcps1.3.4.3.2.4.1.1"><p id="vpc_subnetpools_0004__p1596613445611"><strong id="vpc_subnetpools_0004__b1269113154415">Attribute</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.03%" id="mcps1.3.4.3.2.4.1.2"><p id="vpc_subnetpools_0004__p49667449616"><strong id="vpc_subnetpools_0004__b6130151714114">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.64%" id="mcps1.3.4.3.2.4.1.3"><p id="vpc_subnetpools_0004__p8966144413616"><strong id="vpc_subnetpools_0004__b5249118144114">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_subnetpools_0004__row28303131105515"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p2014344105614">id</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p28944191105614">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p53796361105614">Specifies the subnet pool ID.</p>
<p id="vpc_subnetpools_0004__p1089535311426">This parameter is not mandatory when you query subnet pools.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row1196634410618"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p696615445611">name</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p3966104412620">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p89666442613">Specifies the subnet pool name.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row9772661105515"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p49939441105624">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p18562940105624">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p682749310257">Specifies the IP address version.</p>
<p id="vpc_subnetpools_0004__p33352482102727">The value can be <strong id="vpc_subnetpools_0004__b118819461678">4</strong> (IPv4) or <strong id="vpc_subnetpools_0004__b19881746774">6</strong> (IPv6).</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row89665441569"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p79664442613">default_quota</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p496616449616">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p7968244361">Specifies the upper limit of the prefix space that can be allocated from the subnet pool to the subnet. For IPv4 subnet pools, default_quota is measured in units of /32. For IPv6 subnet pools, default_quota is measured in units of /64.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row157121839115912"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p870051413911">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p15700614790">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row2067783695917"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p11508184345913">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p1651534311599">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p552334314592">Specifies the time (UTC) when the subnet pool is created.</p>
<p id="vpc_subnetpools_0004__p65980291419">Format: <em id="vpc_subnetpools_0004__i895045134412">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row1428916334597"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p15531114325914">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p853513432597">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p1954364325913">Specifies the time (UTC) when the subnet pool rule is updated.</p>
<p id="vpc_subnetpools_0004__p1876431451910">Format: <em id="vpc_subnetpools_0004__i13677855124417">yyyy-MM-ddTHH:mm:ss</em></p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row1796820448610"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p296834417616">prefixes</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p209681244961">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__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_0004__row14968744267"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p199681944763">min_prefixlen</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p49682044566">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__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_0004__b196591926184719">8</strong>, and that of an IPv6 subnet is <strong id="vpc_subnetpools_0004__b106601626194718">64</strong>.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row22360302105653"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p1404384110577">address_scope_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p930111615640">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p2924364410577">Specifies the ID of the address range allocated to the subnet pool.</p>
<p id="vpc_subnetpools_0004__p62544866102532">Only the administrator can specify this attribute.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row1597013444615"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p19970184415616">shared</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p597044417614">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p159708444612">Specifies whether the network can be shared to all projects. </p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row99704441966"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p3970744162">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p597014415620">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p03241213320">Specifies the project ID. </p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row139702441463"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p4970154418614">default_prefixlen</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p397018441063">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p3970044567">Specifies the default prefix to be allocated to a subnet if the <strong id="vpc_subnetpools_0004__b1965014521224">cidr</strong> or <strong id="vpc_subnetpools_0004__b96561529226">prefixlen</strong> is not specified when you create the subnet. The default value is <strong id="vpc_subnetpools_0004__b45561515112412">8</strong> for an IPv4 subnet and <strong id="vpc_subnetpools_0004__b135572159248">64</strong> for an IPv6 subnet.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row197118445620"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p1297110441967">max_prefixlen</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p697184412610">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__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_0004__b118101143144717">32</strong>, and that of an IPv6 subnet is <strong id="vpc_subnetpools_0004__b12816164318477">128</strong>.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row1597174413610"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p397114441268">description</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p5971104410613">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p097164411616">Provides supplementary information about the subnet pool.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row129712441610"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p1971174417613">is_default</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p1597254413618">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p17972114418620">Specifies whether this is the default subnet pool.</p>
</td>
</tr>
<tr id="vpc_subnetpools_0004__row6412351155912"><td class="cellrowborder" valign="top" width="24.33%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_subnetpools_0004__p11412115135915">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_subnetpools_0004__p1847018315584">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="55.64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_subnetpools_0004__p741295135910">Specifies the tags.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_subnetpools_0004__section5055526711495"><h4 class="sectiontitle">Example:</h4><p id="vpc_subnetpools_0004__p122776133116">Example request</p>
<pre class="screen" id="vpc_subnetpools_0004__screen4017959713452">PUT https://{Endpoint}/v2.0/subnetpools/03f761e6-eee0-43fc-a921-8acf64c14988
{
"subnetpool": {
"name": "my-new-subnetpool-name",
"prefixes": [
"2001:db8::/64",
"2001:db8:0:1::/64",
"2001:db8:0:2::/64"
],
"min_prefixlen": 64,
"default_prefixlen": 64,
"max_prefixlen": 64
}
}</pre>
</div>
<p id="vpc_subnetpools_0004__p1849939113114">Example response</p>
<pre class="screen" id="vpc_subnetpools_0004__screen48812841155339">{
"subnetpool": {
"name": "my-new-subnetpool-name",
"default_quota": null,
"is_default": false,
"project_id": "9fadcee8aa7c40cdb2114fff7d569c08",
"tenant_id": "9fadcee8aa7c40cdb2114fff7d569c08",
"prefixes": [
"2001:db8::/63",
"2001:db8:0:2::/64"
],
"min_prefixlen": 64,
"address_scope_id": null,
"ip_version": 6,
"shared": false,
"default_prefixlen": 64,
"id": "03f761e6-eee0-43fc-a921-8acf64c14988",
"max_prefixlen": 64,
"description": "",
"created_at": "2018-09-20T02:15:34",
"updated_at": "2018-09-20T02:15:34",
"tags": []
}
}</pre>
<div class="section" id="vpc_subnetpools_0004__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_subnetpools_0004__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="vpc_subnetpools_0004__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_subnetpools_0004__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_subnetpools_0000.html">Subnet Pool</a></div>
</div>
</div>
View Git Blame Copy Permalink