yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/vpc/api-ref/vpc_apiv3_0022.html
fanqinying 05458809ab VPC API 20250121 version 
Reviewed-by: Szirovicza Gergő <a94652429@noreply.gitea.eco.tsi-dev.otc-service.com>
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: fanqinying <fanqinying@huawei.com>
Co-committed-by: fanqinying <fanqinying@huawei.com>
2025-09-11 14:33:55 +00:00

450 lines
37 KiB
HTML
Raw Blame History

<a name="vpc_apiv3_0022"></a><a name="vpc_apiv3_0022"></a>
<h1 class="topictitle1">Creating an IP Address Group</h1>
<div id="body1708331107508"><div class="section" id="vpc_apiv3_0022__section17258238820"><h4 class="sectiontitle">Function</h4><p id="vpc_apiv3_0022__p172513231817">This API is used to create an IP address group.</p>
</div>
<div class="section" id="vpc_apiv3_0022__section5251231484"><h4 class="sectiontitle">Constraints</h4><p id="vpc_apiv3_0022__p12562312812">The default IP address group quota for each account is 50.</p>
</div>
<div class="section" id="vpc_apiv3_0022__section13251323983"><h4 class="sectiontitle">URI</h4><p id="vpc_apiv3_0022__p1726132316815">POST /v3/{project_id}/vpc/address-groups</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0022__table11262233811" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="vpc_apiv3_0022__row17266230812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="vpc_apiv3_0022__p18269230811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="vpc_apiv3_0022__p1261523581">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="vpc_apiv3_0022__p326172311813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="vpc_apiv3_0022__p4264231815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0022__row16262231481"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="vpc_apiv3_0022__p192611231083">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="vpc_apiv3_0022__p152692313812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="vpc_apiv3_0022__p127152316814">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="vpc_apiv3_0022__p122732311815">Project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0022__section527162314814"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0022__request_CreateAddressGroupRequestBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="vpc_apiv3_0022__row1027423283"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="vpc_apiv3_0022__p72762318819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="vpc_apiv3_0022__p19271923286">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="vpc_apiv3_0022__p72772314820">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="vpc_apiv3_0022__p162722313816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0022__row6271231289"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="vpc_apiv3_0022__p4281923084">dry_run</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="vpc_apiv3_0022__p3284231887">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="vpc_apiv3_0022__p32862312813">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><ul id="vpc_apiv3_0022__ul122813236817"><li id="vpc_apiv3_0022__li152892312811"><p id="vpc_apiv3_0022__p17281823988"><a name="vpc_apiv3_0022__li152892312811"></a><a name="li152892312811"></a>Whether to only send the check request.</p>
</li><li id="vpc_apiv3_0022__li102817231181"><p id="vpc_apiv3_0022__p182811233816"><a name="vpc_apiv3_0022__li102817231181"></a><a name="li102817231181"></a>The value can be one of the following:</p>
<ul id="vpc_apiv3_0022__ul1282233810"><li id="vpc_apiv3_0022__li7282233813"><p id="vpc_apiv3_0022__p52812231181"><a name="vpc_apiv3_0022__li7282233813"></a><a name="li7282233813"></a><strong id="vpc_apiv3_0022__b82862313813">true</strong>: A check request will be sent and the IP address group will not be created. Check items include mandatory parameters, request format, and constraints. If the check fails, the system returns an error. If the check succeeds, response code 202 will be returned.</p>
</li><li id="vpc_apiv3_0022__li728223483"><p id="vpc_apiv3_0022__p112811231789"><a name="vpc_apiv3_0022__li728223483"></a><a name="li728223483"></a><strong id="vpc_apiv3_0022__b52822312820">false</strong> (default value): A request will be sent and an IP address group will be created.</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row7271023685"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="vpc_apiv3_0022__p3289231380">address_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="vpc_apiv3_0022__p12289231682">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="vpc_apiv3_0022__p1628523787"><a href="#vpc_apiv3_0022__request_CreateAddressGroupOption">CreateAddressGroupOption</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="vpc_apiv3_0022__p328023885">Request body for creating an IP address group.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0022__request_CreateAddressGroupOption"></a><a name="request_CreateAddressGroupOption"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0022__request_CreateAddressGroupOption" frame="border" border="1" rules="all"><caption><b>Table 3 </b>CreateAddressGroupOption</caption><thead align="left"><tr id="vpc_apiv3_0022__row3292231881"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="vpc_apiv3_0022__p182972316819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="vpc_apiv3_0022__p9292231685">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="vpc_apiv3_0022__p152942310818">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="vpc_apiv3_0022__p193015236815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0022__row13295236818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="vpc_apiv3_0022__p1930122317813">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="vpc_apiv3_0022__p1930123681">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="vpc_apiv3_0022__p230102312817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><ul id="vpc_apiv3_0022__ul16305231085"><li id="vpc_apiv3_0022__li6306231781"><p id="vpc_apiv3_0022__p9304231581"><a name="vpc_apiv3_0022__li6306231781"></a><a name="li6306231781"></a>IP address group name.</p>
</li><li id="vpc_apiv3_0022__li153011232810"><p id="vpc_apiv3_0022__p203014231886"><a name="vpc_apiv3_0022__li153011232810"></a><a name="li153011232810"></a>The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row229112315813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="vpc_apiv3_0022__p16309232812">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="vpc_apiv3_0022__p1301623686">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="vpc_apiv3_0022__p1030132311818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><ul id="vpc_apiv3_0022__ul14302235816"><li id="vpc_apiv3_0022__li153018231818"><p id="vpc_apiv3_0022__p153016232815"><a name="vpc_apiv3_0022__li153018231818"></a><a name="li153018231818"></a>Description about the IP address group.</p>
</li><li id="vpc_apiv3_0022__li630182315814"><p id="vpc_apiv3_0022__p93017231880"><a name="vpc_apiv3_0022__li630182315814"></a><a name="li630182315814"></a>The value can contain no more than 255 characters and cannot contain angle brackets (&lt; or &gt;).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row6291523289"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="vpc_apiv3_0022__p1301123488">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="vpc_apiv3_0022__p93017236812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="vpc_apiv3_0022__p6315231983">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><ul id="vpc_apiv3_0022__ul193152317818"><li id="vpc_apiv3_0022__li1431122310818"><p id="vpc_apiv3_0022__p19319231483"><a name="vpc_apiv3_0022__li1431122310818"></a><a name="li1431122310818"></a>Whether it is an IPv4 or IPv6 address group.</p>
</li><li id="vpc_apiv3_0022__li9311423889"><p id="vpc_apiv3_0022__p83112231982"><a name="vpc_apiv3_0022__li9311423889"></a><a name="li9311423889"></a>The value can be:</p>
<ul id="vpc_apiv3_0022__ul163112314811"><li id="vpc_apiv3_0022__li63110238818"><p id="vpc_apiv3_0022__p831152317813"><a name="vpc_apiv3_0022__li63110238818"></a><a name="li63110238818"></a><strong id="vpc_apiv3_0022__b1131182316811">4</strong>, IPv4 address groups.</p>
</li><li id="vpc_apiv3_0022__li63110234819"><p id="vpc_apiv3_0022__p331223780"><a name="vpc_apiv3_0022__li63110234819"></a><a name="li63110234819"></a><strong id="vpc_apiv3_0022__b931423383">6</strong>, IPv6 address groups.</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row1229122315818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="vpc_apiv3_0022__p6315231789">ip_set</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="vpc_apiv3_0022__p8321523086">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="vpc_apiv3_0022__p83210231812">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><ul id="vpc_apiv3_0022__ul15324231689"><li id="vpc_apiv3_0022__li19322023686"><p id="vpc_apiv3_0022__p7321623685"><a name="vpc_apiv3_0022__li19322023686"></a><a name="li19322023686"></a>IP address sets in an IP address group.</p>
</li><li id="vpc_apiv3_0022__li1432523188"><p id="vpc_apiv3_0022__p7327231589"><a name="vpc_apiv3_0022__li1432523188"></a><a name="li1432523188"></a>The value can be a single IP address, IP address range, or CIDR block.</p>
</li><li id="vpc_apiv3_0022__li18328234817"><p id="vpc_apiv3_0022__p183212232819"><a name="vpc_apiv3_0022__li18328234817"></a><a name="li18328234817"></a>The default maximum number of IP address sets, including IP addresses, IP address ranges, and CIDR blocks, in an IP address group, is 20.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row1729102318819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="vpc_apiv3_0022__p13217237812">ip_extra_set</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="vpc_apiv3_0022__p7327231815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="vpc_apiv3_0022__p2339232820">Array of <a href="#vpc_apiv3_0022__request_IpExtraSetOption">IpExtraSetOption</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><ul id="vpc_apiv3_0022__ul13319236810"><li id="vpc_apiv3_0022__li03319234815"><p id="vpc_apiv3_0022__p73392310815"><a name="vpc_apiv3_0022__li03319234815"></a><a name="li03319234815"></a>IP addresses and their remarks in an IP address group.</p>
</li><li id="vpc_apiv3_0022__li13330231988"><p id="vpc_apiv3_0022__p16333231585"><a name="vpc_apiv3_0022__li13330231988"></a><a name="li13330231988"></a>The default quota is 20. Either this parameter or <strong id="vpc_apiv3_0022__b8333231082">ip_set</strong> must be specified.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0022__request_IpExtraSetOption"></a><a name="request_IpExtraSetOption"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0022__request_IpExtraSetOption" frame="border" border="1" rules="all"><caption><b>Table 4 </b>IpExtraSetOption</caption><thead align="left"><tr id="vpc_apiv3_0022__row63314231485"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="vpc_apiv3_0022__p10331023285">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="vpc_apiv3_0022__p1933223486">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="vpc_apiv3_0022__p53316234814">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="vpc_apiv3_0022__p133415231885">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0022__row11331123985"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="vpc_apiv3_0022__p1734162314814">ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="vpc_apiv3_0022__p16349231886">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="vpc_apiv3_0022__p16349234811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><ul id="vpc_apiv3_0022__ul33482315817"><li id="vpc_apiv3_0022__li73472310815"><p id="vpc_apiv3_0022__p93410234818"><a name="vpc_apiv3_0022__li73472310815"></a><a name="li73472310815"></a>An IP address, IP address range, or CIDR block. Both IPv4 and IPv6 are supported.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row15334236819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="vpc_apiv3_0022__p203419231389">remarks</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="vpc_apiv3_0022__p103412312819">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="vpc_apiv3_0022__p193482320810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><ul id="vpc_apiv3_0022__ul93472319819"><li id="vpc_apiv3_0022__li193419231387"><p id="vpc_apiv3_0022__p3345231686"><a name="vpc_apiv3_0022__li193419231387"></a><a name="li193419231387"></a>Supplementary information about the IP address, IP address range, or CIDR block.</p>
</li><li id="vpc_apiv3_0022__li19340231489"><p id="vpc_apiv3_0022__p153462317815"><a name="vpc_apiv3_0022__li19340231489"></a><a name="li19340231489"></a>The value can contain no more than 255 characters and cannot contain angle brackets (&lt; or &gt;).</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0022__section11351423780"><h4 class="sectiontitle">Response Parameters</h4><p id="vpc_apiv3_0022__p1735102319813"><strong id="vpc_apiv3_0022__b163513238810">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0022__response_CreateAddressGroupResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="vpc_apiv3_0022__row1335162312813"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_apiv3_0022__p103515231481">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_apiv3_0022__p11356231488">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_apiv3_0022__p19357238815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0022__row1535123587"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiv3_0022__p153613231189">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiv3_0022__p4369235813">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_apiv3_0022__p2361223883">Request ID.</p>
</td>
</tr>
<tr id="vpc_apiv3_0022__row14350231383"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_apiv3_0022__p1336923188">address_group</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_apiv3_0022__p6365235816"><a href="#vpc_apiv3_0022__response_AddressGroup">AddressGroup</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_apiv3_0022__p1936132319814">Response body for creating an IP address group.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0022__response_AddressGroup"></a><a name="response_AddressGroup"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0022__response_AddressGroup" frame="border" border="1" rules="all"><caption><b>Table 6 </b>AddressGroup</caption><thead align="left"><tr id="vpc_apiv3_0022__row12366232080"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="vpc_apiv3_0022__p33712312811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.2"><p id="vpc_apiv3_0022__p5371723184">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p id="vpc_apiv3_0022__p73732314817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0022__row836162314817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0022__p93711231980">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0022__p53782317819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0022__ul16377231288"><li id="vpc_apiv3_0022__li1337523083"><p id="vpc_apiv3_0022__p83742316813"><a name="vpc_apiv3_0022__li1337523083"></a><a name="li1337523083"></a>IP address group ID that uniquely identifies the IP address group.</p>
</li><li id="vpc_apiv3_0022__li73814234814"><p id="vpc_apiv3_0022__p238823086"><a name="vpc_apiv3_0022__li73814234814"></a><a name="li73814234814"></a>The value is a string in UUID format.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row3369238817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0022__p153816231482">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0022__p1538142318815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0022__ul13381323286"><li id="vpc_apiv3_0022__li53819239818"><p id="vpc_apiv3_0022__p43812312818"><a name="vpc_apiv3_0022__li53819239818"></a><a name="li53819239818"></a>IP address group name.</p>
</li><li id="vpc_apiv3_0022__li2388238818"><p id="vpc_apiv3_0022__p1138223181"><a name="vpc_apiv3_0022__li2388238818"></a><a name="li2388238818"></a>The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row183611236810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0022__p138142315816">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0022__p16381923886">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0022__ul11381123489"><li id="vpc_apiv3_0022__li133811238812"><p id="vpc_apiv3_0022__p143815233814"><a name="vpc_apiv3_0022__li133811238812"></a><a name="li133811238812"></a>Description about the IP address group.</p>
</li><li id="vpc_apiv3_0022__li438923488"><p id="vpc_apiv3_0022__p33812314815"><a name="vpc_apiv3_0022__li438923488"></a><a name="li438923488"></a>The value can contain no more than 255 characters.</p>
</li><li id="vpc_apiv3_0022__li153892316815"><p id="vpc_apiv3_0022__p93813239820"><a name="vpc_apiv3_0022__li153892316815"></a><a name="li153892316815"></a>The value cannot contain angle brackets (&lt; or &gt;).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row193662313811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0022__p63911231883">ip_set</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0022__p17395237818">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0022__ul13913233819"><li id="vpc_apiv3_0022__li10393231817"><p id="vpc_apiv3_0022__p1839923486"><a name="vpc_apiv3_0022__li10393231817"></a><a name="li10393231817"></a>IP address sets in an IP address group.</p>
</li><li id="vpc_apiv3_0022__li163962312812"><p id="vpc_apiv3_0022__p439523589"><a name="vpc_apiv3_0022__li163962312812"></a><a name="li163962312812"></a>The value can be a single IP address, IP address range, or CIDR block.</p>
</li><li id="vpc_apiv3_0022__li5398235814"><p id="vpc_apiv3_0022__p183952310811"><a name="vpc_apiv3_0022__li5398235814"></a><a name="li5398235814"></a>The default maximum number of IP address sets, including IP addresses, IP address ranges, and CIDR blocks, in an IP address group, is 20.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row6372236810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0022__p19396232810">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0022__p19391423888">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0022__ul18398232088"><li id="vpc_apiv3_0022__li63912231888"><p id="vpc_apiv3_0022__p7391423781"><a name="vpc_apiv3_0022__li63912231888"></a><a name="li63912231888"></a>Whether it is an IPv4 or IPv6 address group.</p>
</li><li id="vpc_apiv3_0022__li10397235819"><p id="vpc_apiv3_0022__p1040923686"><a name="vpc_apiv3_0022__li10397235819"></a><a name="li10397235819"></a>The value can be one of the following:</p>
<ul id="vpc_apiv3_0022__ul124082319817"><li id="vpc_apiv3_0022__li04062311814"><p id="vpc_apiv3_0022__p5409234815"><a name="vpc_apiv3_0022__li04062311814"></a><a name="li04062311814"></a><strong id="vpc_apiv3_0022__b1340162314813">4</strong> (IPv4 address groups).</p>
</li><li id="vpc_apiv3_0022__li1240123786"><p id="vpc_apiv3_0022__p16401723086"><a name="vpc_apiv3_0022__li1240123786"></a><a name="li1240123786"></a><strong id="vpc_apiv3_0022__b1440152311810">6</strong> (IPv6 address groups).</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row637152318811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0022__p240172310819">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0022__p7405233813">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0022__ul14401923583"><li id="vpc_apiv3_0022__li640182310816"><p id="vpc_apiv3_0022__p104016231685"><a name="vpc_apiv3_0022__li640182310816"></a><a name="li640182310816"></a>Time when the IP address group was created.</p>
</li><li id="vpc_apiv3_0022__li15406231786"><p id="vpc_apiv3_0022__p940623880"><a name="vpc_apiv3_0022__li15406231786"></a><a name="li15406231786"></a>The value is a UTC time in the format of <em id="vpc_apiv3_0022__i54082314817">yyyy-MM-ddTHH:mm:ss</em>, which is automatically generated by the system.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row12378231816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0022__p24020235819">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0022__p17404231881">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0022__ul54032318811"><li id="vpc_apiv3_0022__li14401623585"><p id="vpc_apiv3_0022__p54015231185"><a name="vpc_apiv3_0022__li14401623585"></a><a name="li14401623585"></a>Time when the IP address group was last updated.</p>
</li><li id="vpc_apiv3_0022__li11401823483"><p id="vpc_apiv3_0022__p104052317812"><a name="vpc_apiv3_0022__li11401823483"></a><a name="li11401823483"></a>The value is a UTC time in the format of <em id="vpc_apiv3_0022__i6407231883">yyyy-MM-ddTHH:mm:ss</em>, which is automatically generated by the system.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row8370231819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0022__p140823886">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0022__p84115231389">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0022__ul18411231286"><li id="vpc_apiv3_0022__li184112231587"><p id="vpc_apiv3_0022__p7414231181"><a name="vpc_apiv3_0022__li184112231587"></a><a name="li184112231587"></a>ID of the project where the IP address group is used.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row937323089"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_apiv3_0022__p12422231814">ip_extra_set</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_apiv3_0022__p19425235816">Array of <a href="#vpc_apiv3_0022__response_IpExtraSetRespOption">IpExtraSetRespOption</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_apiv3_0022__ul17421423182"><li id="vpc_apiv3_0022__li94232315810"><p id="vpc_apiv3_0022__p343152319810"><a name="vpc_apiv3_0022__li94232315810"></a><a name="li94232315810"></a>IP address sets and their remarks in an IP address group.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0022__response_ResponseTag" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ResponseTag</caption><thead align="left"><tr id="vpc_apiv3_0022__row5438231813"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="vpc_apiv3_0022__p54316238813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.2"><p id="vpc_apiv3_0022__p1432023287">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.5.2.4.1.3"><p id="vpc_apiv3_0022__p194312239818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0022__row174362318810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="vpc_apiv3_0022__p14314231786">key</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="vpc_apiv3_0022__p9431823989">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><ul id="vpc_apiv3_0022__ul3585326104"><li id="vpc_apiv3_0022__li145851921103"><p id="vpc_apiv3_0022__p65857241011"><a name="vpc_apiv3_0022__li145851921103"></a><a name="li145851921103"></a>Definition: Tag key.</p>
</li><li id="vpc_apiv3_0022__li4585622108"><p id="vpc_apiv3_0022__p158592191010"><a name="vpc_apiv3_0022__li4585622108"></a><a name="li4585622108"></a>Range:</p>
<ul id="vpc_apiv3_0022__ul1058511241010"><li id="vpc_apiv3_0022__li0585102141010"><p id="vpc_apiv3_0022__p1158519211011"><a name="vpc_apiv3_0022__li0585102141010"></a><a name="li0585102141010"></a>Each key can contain up to 36 Unicode characters and cannot be left blank.</p>
</li><li id="vpc_apiv3_0022__li155853212101"><p id="vpc_apiv3_0022__p185857291017"><a name="vpc_apiv3_0022__li155853212101"></a><a name="li155853212101"></a>Each key value of a resource must be unique.</p>
</li><li id="vpc_apiv3_0022__li3585025105"><p id="vpc_apiv3_0022__p2586102171014"><a name="vpc_apiv3_0022__li3585025105"></a><a name="li3585025105"></a>The value can contain:</p>
<ul id="vpc_apiv3_0022__ul1358618271019"><li id="vpc_apiv3_0022__li658611215104"><p id="vpc_apiv3_0022__p17586192201013"><a name="vpc_apiv3_0022__li658611215104"></a><a name="li658611215104"></a>Letters</p>
</li><li id="vpc_apiv3_0022__li6586102191017"><p id="vpc_apiv3_0022__p658616271010"><a name="vpc_apiv3_0022__li6586102191017"></a><a name="li6586102191017"></a>Digits</p>
</li><li id="vpc_apiv3_0022__li758619218107"><p id="vpc_apiv3_0022__p558618214106"><a name="vpc_apiv3_0022__li758619218107"></a><a name="li758619218107"></a>Special characters: underscores (_) ,at signs (@), and hyphens (-)</p>
</li></ul>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row143423081"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="vpc_apiv3_0022__p74482310810">value</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="vpc_apiv3_0022__p16441623682">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><ul id="vpc_apiv3_0022__ul10586625104"><li id="vpc_apiv3_0022__li7586172161016"><p id="vpc_apiv3_0022__p7586102121011"><a name="vpc_apiv3_0022__li7586172161016"></a><a name="li7586172161016"></a>Definition: Tag value.</p>
</li><li id="vpc_apiv3_0022__li458612213107"><p id="vpc_apiv3_0022__p185861261014"><a name="vpc_apiv3_0022__li458612213107"></a><a name="li458612213107"></a>Range:</p>
<ul id="vpc_apiv3_0022__ul1058622161018"><li id="vpc_apiv3_0022__li35861222107"><p id="vpc_apiv3_0022__p19586722108"><a name="vpc_apiv3_0022__li35861222107"></a><a name="li35861222107"></a>Each value can contain up to 43 Unicode characters and can be left blank.</p>
</li><li id="vpc_apiv3_0022__li45861423105"><p id="vpc_apiv3_0022__p55864231017"><a name="vpc_apiv3_0022__li45861423105"></a><a name="li45861423105"></a>The value can contain:</p>
<ul id="vpc_apiv3_0022__ul13586102131015"><li id="vpc_apiv3_0022__li85865271019"><p id="vpc_apiv3_0022__p1958632151014"><a name="vpc_apiv3_0022__li85865271019"></a><a name="li85865271019"></a>Letters</p>
</li><li id="vpc_apiv3_0022__li758613211016"><p id="vpc_apiv3_0022__p458617211106"><a name="vpc_apiv3_0022__li758613211016"></a><a name="li758613211016"></a>Digits</p>
</li><li id="vpc_apiv3_0022__li1758614241017"><p id="vpc_apiv3_0022__p135867215104"><a name="vpc_apiv3_0022__li1758614241017"></a><a name="li1758614241017"></a>Special characters: underscore (_), at signs (@), and hyphen (-)</p>
</li></ul>
</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_apiv3_0022__response_IpExtraSetRespOption"></a><a name="response_IpExtraSetRespOption"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0022__response_IpExtraSetRespOption" frame="border" border="1" rules="all"><caption><b>Table 8 </b>IpExtraSetRespOption</caption><thead align="left"><tr id="vpc_apiv3_0022__row3461523788"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="vpc_apiv3_0022__p31536232085">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.2"><p id="vpc_apiv3_0022__p121538234814">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.6.2.4.1.3"><p id="vpc_apiv3_0022__p215312234820">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0022__row144614233814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="vpc_apiv3_0022__p13153112315812">ip</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="vpc_apiv3_0022__p1315310239812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><ul id="vpc_apiv3_0022__ul515311231481"><li id="vpc_apiv3_0022__li115332311816"><p id="vpc_apiv3_0022__p11153523880"><a name="vpc_apiv3_0022__li115332311816"></a><a name="li115332311816"></a>An IP address, IP address range, or CIDR block. Both IPv4 and IPv6 are supported.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0022__row2463231086"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="vpc_apiv3_0022__p415310237811">remarks</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="vpc_apiv3_0022__p215312231483">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><ul id="vpc_apiv3_0022__ul1515317231288"><li id="vpc_apiv3_0022__li19154423083"><p id="vpc_apiv3_0022__p17154112312813"><a name="vpc_apiv3_0022__li19154423083"></a><a name="li19154423083"></a>Supplementary information about the IP address, IP address range, or CIDR block.</p>
</li><li id="vpc_apiv3_0022__li1315418231987"><p id="vpc_apiv3_0022__p1115417231780"><a name="vpc_apiv3_0022__li1315418231987"></a><a name="li1315418231987"></a>The value can contain no more than 255 characters and cannot contain angle brackets (&lt; or &gt;).</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0022__section131541323586"><h4 class="sectiontitle">Example Requests</h4><p id="vpc_apiv3_0022__p8154023483">Create an IP address group named <strong id="vpc_apiv3_0022__b1215417234810">AutoTester746010.580123789</strong>, set the IP version to IPv4, and specify the IP set as 192.168.3.2, 192.168.3.40, 192.168.3.20-192.168.3.100, and 192.168.5.0/24.</p>
<pre class="screen" id="vpc_apiv3_0022__screen11548235815">POST https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups
{
"address_group" : {
"ip_version" : 4,
"name" : "AutoTester746010.580123789",
"ip_set" : [ "192.168.3.2", "192.168.3.40", "192.168.3.20-192.168.3.100", "192.168.5.0/24" ],
"description" : "test",
"enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
"max_capacity" : 20
}
}</pre>
</div>
<div class="section" id="vpc_apiv3_0022__section1815418232082"><h4 class="sectiontitle">Example Responses</h4><p id="vpc_apiv3_0022__p715452311813"><strong id="vpc_apiv3_0022__b91546234814">Status code: 201</strong></p>
<p id="vpc_apiv3_0022__p71541423385">Normal response to the POST operation. For more status codes, see <a href="vpc_api_0002.html">Status Codes</a>.</p>
<pre class="screen" id="vpc_apiv3_0022__screen1915413237819">{
"address_group" : {
"id" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08",
"name" : "AutoTester746010.580123789",
"tenant_id" : "b2782e6708b8475c993e6064bc456bf8",
"ip_version" : 4,
"max_capacity" : 20,
"ip_set" : [ "192.168.5.0/24", "192.168.3.20-192.168.3.100", "192.168.3.40", "192.168.3.2" ],
"ip_extra_set" : [ {
"ip" : "192.168.5.0/24",
"remarks" : null
}, {
"ip" : "192.168.3.20-192.168.3.100",
"remarks" : null
}, {
"ip" : "192.168.3.40",
"remarks" : null
}, {
"ip" : "192.168.3.2",
"remarks" : null
} ],
"enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
"created_at" : "2019-06-28T02:06:38.000+00:00",
"updated_at" : "2019-06-28T02:06:38.000+00:00",
"description" : "test",
"status" : "NORMAL",
"status_message" : "",
"tags" : [ ]
},
"request_id" : "f568db7a-2675-4271-8747-3e3f1c6381ba"
}</pre>
</div>
<div class="section" id="vpc_apiv3_0022__section191548231681"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0022__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="vpc_apiv3_0022__row5480231982"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="vpc_apiv3_0022__p19154223882">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="vpc_apiv3_0022__p915418238819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0022__row04882317816"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="vpc_apiv3_0022__p61545234817">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="vpc_apiv3_0022__p315410231282">Normal response to the POST operation. For more status codes, see <a href="vpc_api_0002.html">Status Codes</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0022__section15154423589"><h4 class="sectiontitle">Error Codes</h4><p id="vpc_apiv3_0022__p91541023787">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_apiv3_0021.html">IP Address Group</a></div>
</div>
</div>
View Git Blame Copy Permalink