doc-exports/docs/vpc/api-ref/vpc_apiv3_0023.html

<a name="vpc_apiv3_0023"></a><a name="vpc_apiv3_0023"></a>

<h1 class="topictitle1">Querying IP Address Groups</h1>
<div id="body1708331107508"><div class="section" id="vpc_apiv3_0023__section6596232087"><h4 class="sectiontitle">Function</h4><p id="vpc_apiv3_0023__p85916236810">This API is used to query IP address groups based on filter criteria.</p>
</div>
<div class="section" id="vpc_apiv3_0023__section1360823786"><h4 class="sectiontitle">URI</h4><p id="vpc_apiv3_0023__p20601223284">GET /v3/{project_id}/vpc/address-groups</p>

<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0023__table13603231586" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="vpc_apiv3_0023__row56017232816"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="vpc_apiv3_0023__p15605231785">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="vpc_apiv3_0023__p166013238813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="vpc_apiv3_0023__p136015231283">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="vpc_apiv3_0023__p136118231188">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0023__row56018231986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="vpc_apiv3_0023__p8615238815">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="vpc_apiv3_0023__p46119234811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="vpc_apiv3_0023__p261623988">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="vpc_apiv3_0023__p16110231783">Project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>

<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0023__table1462162311813" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="vpc_apiv3_0023__row7614231981"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="vpc_apiv3_0023__p062123881">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="vpc_apiv3_0023__p462132310817">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="vpc_apiv3_0023__p962102310813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="vpc_apiv3_0023__p106213231586">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0023__row9611237820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_apiv3_0023__p186292313816">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_apiv3_0023__p1162223381">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_apiv3_0023__p06214231186">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><ul id="vpc_apiv3_0023__ul14623231382"><li id="vpc_apiv3_0023__li13621423284"><p id="vpc_apiv3_0023__p46214230817"><a name="vpc_apiv3_0023__li13621423284"></a><a name="li13621423284"></a>Number of records returned on each page.</p>
</li><li id="vpc_apiv3_0023__li10620237819"><p id="vpc_apiv3_0023__p762123780"><a name="vpc_apiv3_0023__li10620237819"></a><a name="li10620237819"></a>Value range: 0 to 2000.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0023__row176120231180"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_apiv3_0023__p2621323584">marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_apiv3_0023__p1062102310816">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_apiv3_0023__p4635231088">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_apiv3_0023__p156382311812">Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.</p>
</td>
</tr>
<tr id="vpc_apiv3_0023__row6613231181"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_apiv3_0023__p196392311813">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_apiv3_0023__p1632023382">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_apiv3_0023__p20634231389">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_apiv3_0023__p196362310811">Unique ID of an IP address group, which is used to filter the IP address group. Multiple IDs can be specified for filtering.</p>
</td>
</tr>
<tr id="vpc_apiv3_0023__row146114239817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_apiv3_0023__p563122313811">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_apiv3_0023__p196342312819">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_apiv3_0023__p206310231787">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_apiv3_0023__p86315231288">IP address group name, which is used to filter the IP address group. Multiple names can be specified for filtering.</p>
</td>
</tr>
<tr id="vpc_apiv3_0023__row14611123587"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_apiv3_0023__p76317231986">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_apiv3_0023__p136314234818">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_apiv3_0023__p963112312817">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><ul id="vpc_apiv3_0023__ul36372316810"><li id="vpc_apiv3_0023__li18639231182"><p id="vpc_apiv3_0023__p1063423288"><a name="vpc_apiv3_0023__li18639231182"></a><a name="li18639231182"></a>IP address version, which is used to filter the IP address group.</p>
</li><li id="vpc_apiv3_0023__li1563102312812"><p id="vpc_apiv3_0023__p6642231787"><a name="vpc_apiv3_0023__li1563102312812"></a><a name="li1563102312812"></a>Value range: <strong id="vpc_apiv3_0023__b6645231087">4</strong>, <strong id="vpc_apiv3_0023__b2647231589">6</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0023__row146117231484"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpc_apiv3_0023__p19640232814">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpc_apiv3_0023__p96414231983">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpc_apiv3_0023__p36412231688">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpc_apiv3_0023__p19647232815">Supplementary information about an IP address group, which is used to filter the IP address group. Multiple descriptions can be specified for filtering.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0023__section165723180"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_apiv3_0023__p206516237816">None</p>
</div>
<div class="section" id="vpc_apiv3_0023__section4656231480"><h4 class="sectiontitle">Response Parameters</h4><p id="vpc_apiv3_0023__p26514231088"><strong id="vpc_apiv3_0023__b46522311817">Status code: 200</strong></p>

<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0023__response_ListAddressGroupResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="vpc_apiv3_0023__row8650231380"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="vpc_apiv3_0023__p3661423981">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="vpc_apiv3_0023__p1366152316814">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="vpc_apiv3_0023__p116672319815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0023__row20656231814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_apiv3_0023__p196616235810">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_apiv3_0023__p966182318815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_apiv3_0023__p6666231184">Request ID.</p>
</td>
</tr>
<tr id="vpc_apiv3_0023__row1665923083"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_apiv3_0023__p12663231581">address_groups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_apiv3_0023__p176618231984">Array of <a href="#vpc_apiv3_0023__response_AddressGroup">AddressGroup</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_apiv3_0023__p1666423280">Response body for querying IP address groups.</p>
</td>
</tr>
<tr id="vpc_apiv3_0023__row196512231084"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_apiv3_0023__p146615231080">page_info</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_apiv3_0023__p186611233814"><a href="#vpc_apiv3_0023__response_PageInfo">PageInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_apiv3_0023__p1166152319819">Pagination information.</p>
</td>
</tr>
</tbody>
</table>
</div>

<div class="tablenoborder"><a name="vpc_apiv3_0023__response_AddressGroup"></a><a name="response_AddressGroup"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0023__response_AddressGroup" frame="border" border="1" rules="all"><caption><b>Table 4 </b>AddressGroup</caption><thead align="left"><tr id="vpc_apiv3_0023__row667923387"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="vpc_apiv3_0023__p7683237812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="vpc_apiv3_0023__p20681723681">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="vpc_apiv3_0023__p56832313813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0023__row1267223884"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0023__p15681423588">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0023__p176812238814">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0023__ul768182310811"><li id="vpc_apiv3_0023__li968323785"><p id="vpc_apiv3_0023__p86818234812"><a name="vpc_apiv3_0023__li968323785"></a><a name="li968323785"></a>IP address group ID that uniquely identifies the IP address group.</p>
</li><li id="vpc_apiv3_0023__li4685236820"><p id="vpc_apiv3_0023__p1568523886"><a name="vpc_apiv3_0023__li4685236820"></a><a name="li4685236820"></a>The value is a string in UUID format.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0023__row166712231183"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0023__p1868182315819">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0023__p20681123280">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0023__ul5684235819"><li id="vpc_apiv3_0023__li6689238815"><p id="vpc_apiv3_0023__p86814233813"><a name="vpc_apiv3_0023__li6689238815"></a><a name="li6689238815"></a>IP address group name.</p>
</li><li id="vpc_apiv3_0023__li96842317819"><p id="vpc_apiv3_0023__p86872318819"><a name="vpc_apiv3_0023__li96842317819"></a><a name="li96842317819"></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_0023__row15670231383"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0023__p3699231582">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0023__p6692239816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0023__ul46916231885"><li id="vpc_apiv3_0023__li1469142311819"><p id="vpc_apiv3_0023__p11695232812"><a name="vpc_apiv3_0023__li1469142311819"></a><a name="li1469142311819"></a>Description about the IP address group.</p>
</li><li id="vpc_apiv3_0023__li86913231388"><p id="vpc_apiv3_0023__p7694231816"><a name="vpc_apiv3_0023__li86913231388"></a><a name="li86913231388"></a>The value can contain no more than 255 characters.</p>
</li><li id="vpc_apiv3_0023__li76992319810"><p id="vpc_apiv3_0023__p146992317820"><a name="vpc_apiv3_0023__li76992319810"></a><a name="li76992319810"></a>The value cannot contain angle brackets (&lt; or &gt;).</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0023__row1767182315814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0023__p2069023481">ip_set</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0023__p176982320810">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0023__ul57016235811"><li id="vpc_apiv3_0023__li1370132312812"><p id="vpc_apiv3_0023__p15703232812"><a name="vpc_apiv3_0023__li1370132312812"></a><a name="li1370132312812"></a>IP address sets in an IP address group.</p>
</li><li id="vpc_apiv3_0023__li177015233810"><p id="vpc_apiv3_0023__p77062318815"><a name="vpc_apiv3_0023__li177015233810"></a><a name="li177015233810"></a>The value can be a single IP address, IP address range, or CIDR block.</p>
</li><li id="vpc_apiv3_0023__li15702231485"><p id="vpc_apiv3_0023__p7701231383"><a name="vpc_apiv3_0023__li15702231485"></a><a name="li15702231485"></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_0023__row56713237812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0023__p10704231887">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0023__p147032313816">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0023__ul13702231581"><li id="vpc_apiv3_0023__li14701823787"><p id="vpc_apiv3_0023__p16704231819"><a name="vpc_apiv3_0023__li14701823787"></a><a name="li14701823787"></a>Whether it is an IPv4 or IPv6 address group.</p>
</li><li id="vpc_apiv3_0023__li17013231888"><p id="vpc_apiv3_0023__p11701232817"><a name="vpc_apiv3_0023__li17013231888"></a><a name="li17013231888"></a>The value can be one of the following:</p>
<ul id="vpc_apiv3_0023__ul1570162312817"><li id="vpc_apiv3_0023__li27018231284"><p id="vpc_apiv3_0023__p5706231881"><a name="vpc_apiv3_0023__li27018231284"></a><a name="li27018231284"></a><strong id="vpc_apiv3_0023__b7701623281">4</strong> (IPv4 address groups).</p>
</li><li id="vpc_apiv3_0023__li1970423086"><p id="vpc_apiv3_0023__p6701323086"><a name="vpc_apiv3_0023__li1970423086"></a><a name="li1970423086"></a><strong id="vpc_apiv3_0023__b97052317816">6</strong> (IPv6 address groups).</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0023__row1467102311820"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0023__p1370112316815">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0023__p2701823382">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0023__ul187052319810"><li id="vpc_apiv3_0023__li17192317810"><p id="vpc_apiv3_0023__p167113235819"><a name="vpc_apiv3_0023__li17192317810"></a><a name="li17192317810"></a>Time when the IP address group was created.</p>
</li><li id="vpc_apiv3_0023__li271223380"><p id="vpc_apiv3_0023__p87152314818"><a name="vpc_apiv3_0023__li271223380"></a><a name="li271223380"></a>The value is a UTC time in the format of <em id="vpc_apiv3_0023__i17711231782">yyyy-MM-ddTHH:mm:ss</em>, which is automatically generated by the system.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0023__row166718239810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0023__p19715231885">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0023__p1871192312815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0023__ul1971122319820"><li id="vpc_apiv3_0023__li77118231280"><p id="vpc_apiv3_0023__p10711623286"><a name="vpc_apiv3_0023__li77118231280"></a><a name="li77118231280"></a>Time when the IP address group was last updated.</p>
</li><li id="vpc_apiv3_0023__li16712231881"><p id="vpc_apiv3_0023__p07162318810"><a name="vpc_apiv3_0023__li16712231881"></a><a name="li16712231881"></a>The value is a UTC time in the format of <em id="vpc_apiv3_0023__i167114231982">yyyy-MM-ddTHH:mm:ss</em>, which is automatically generated by the system.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0023__row26714232082"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0023__p14718231480">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0023__p971723886">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0023__ul971182319818"><li id="vpc_apiv3_0023__li2712023989"><p id="vpc_apiv3_0023__p371162318815"><a name="vpc_apiv3_0023__li2712023989"></a><a name="li2712023989"></a>ID of the project where the IP address group is used.</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0023__row1667172318816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0023__p117319237813">ip_extra_set</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0023__p3731223785">Array of <a href="#vpc_apiv3_0023__response_IpExtraSetRespOption">IpExtraSetRespOption</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0023__ul1273023485"><li id="vpc_apiv3_0023__li673923287"><p id="vpc_apiv3_0023__p77310231185"><a name="vpc_apiv3_0023__li673923287"></a><a name="li673923287"></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_0023__response_ResponseTag" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResponseTag</caption><thead align="left"><tr id="vpc_apiv3_0023__row77316231287"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="vpc_apiv3_0023__p8744230812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="vpc_apiv3_0023__p27422315816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="vpc_apiv3_0023__p1874102313812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0023__row197414233819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="vpc_apiv3_0023__p4747231587">key</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="vpc_apiv3_0023__p127415237819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><ul id="vpc_apiv3_0023__ul3585326104"><li id="vpc_apiv3_0023__li145851921103"><p id="vpc_apiv3_0023__p65857241011"><a name="vpc_apiv3_0023__li145851921103"></a><a name="li145851921103"></a>Definition: Tag key.</p>
</li><li id="vpc_apiv3_0023__li4585622108"><p id="vpc_apiv3_0023__p158592191010"><a name="vpc_apiv3_0023__li4585622108"></a><a name="li4585622108"></a>Range:</p>
<ul id="vpc_apiv3_0023__ul1058511241010"><li id="vpc_apiv3_0023__li0585102141010"><p id="vpc_apiv3_0023__p1158519211011"><a name="vpc_apiv3_0023__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_0023__li155853212101"><p id="vpc_apiv3_0023__p185857291017"><a name="vpc_apiv3_0023__li155853212101"></a><a name="li155853212101"></a>Each key value of a resource must be unique.</p>
</li><li id="vpc_apiv3_0023__li3585025105"><p id="vpc_apiv3_0023__p2586102171014"><a name="vpc_apiv3_0023__li3585025105"></a><a name="li3585025105"></a>The value can contain:</p>
<ul id="vpc_apiv3_0023__ul1358618271019"><li id="vpc_apiv3_0023__li658611215104"><p id="vpc_apiv3_0023__p17586192201013"><a name="vpc_apiv3_0023__li658611215104"></a><a name="li658611215104"></a>Letters</p>
</li><li id="vpc_apiv3_0023__li6586102191017"><p id="vpc_apiv3_0023__p658616271010"><a name="vpc_apiv3_0023__li6586102191017"></a><a name="li6586102191017"></a>Digits</p>
</li><li id="vpc_apiv3_0023__li758619218107"><p id="vpc_apiv3_0023__p558618214106"><a name="vpc_apiv3_0023__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_0023__row27420233810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="vpc_apiv3_0023__p157511231084">value</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="vpc_apiv3_0023__p117513234819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><ul id="vpc_apiv3_0023__ul10586625104"><li id="vpc_apiv3_0023__li7586172161016"><p id="vpc_apiv3_0023__p7586102121011"><a name="vpc_apiv3_0023__li7586172161016"></a><a name="li7586172161016"></a>Definition: Tag value.</p>
</li><li id="vpc_apiv3_0023__li458612213107"><p id="vpc_apiv3_0023__p185861261014"><a name="vpc_apiv3_0023__li458612213107"></a><a name="li458612213107"></a>Range:</p>
<ul id="vpc_apiv3_0023__ul1058622161018"><li id="vpc_apiv3_0023__li35861222107"><p id="vpc_apiv3_0023__p19586722108"><a name="vpc_apiv3_0023__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_0023__li45861423105"><p id="vpc_apiv3_0023__p55864231017"><a name="vpc_apiv3_0023__li45861423105"></a><a name="li45861423105"></a>The value can contain:</p>
<ul id="vpc_apiv3_0023__ul13586102131015"><li id="vpc_apiv3_0023__li85865271019"><p id="vpc_apiv3_0023__p1958632151014"><a name="vpc_apiv3_0023__li85865271019"></a><a name="li85865271019"></a>Letters</p>
</li><li id="vpc_apiv3_0023__li758613211016"><p id="vpc_apiv3_0023__p458617211106"><a name="vpc_apiv3_0023__li758613211016"></a><a name="li758613211016"></a>Digits</p>
</li><li id="vpc_apiv3_0023__li1758614241017"><p id="vpc_apiv3_0023__p135867215104"><a name="vpc_apiv3_0023__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_0023__response_IpExtraSetRespOption"></a><a name="response_IpExtraSetRespOption"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0023__response_IpExtraSetRespOption" frame="border" border="1" rules="all"><caption><b>Table 6 </b>IpExtraSetRespOption</caption><thead align="left"><tr id="vpc_apiv3_0023__row1676923488"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="vpc_apiv3_0023__p14761423783">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="vpc_apiv3_0023__p187612232810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="vpc_apiv3_0023__p9762236813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0023__row167619231786"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="vpc_apiv3_0023__p177682318819">ip</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="vpc_apiv3_0023__p376223484">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><ul id="vpc_apiv3_0023__ul777723083"><li id="vpc_apiv3_0023__li3772023086"><p id="vpc_apiv3_0023__p187720237810"><a name="vpc_apiv3_0023__li3772023086"></a><a name="li3772023086"></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_0023__row1376523288"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="vpc_apiv3_0023__p67792311810">remarks</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="vpc_apiv3_0023__p377182319811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><ul id="vpc_apiv3_0023__ul127716234819"><li id="vpc_apiv3_0023__li577102311818"><p id="vpc_apiv3_0023__p2773237819"><a name="vpc_apiv3_0023__li577102311818"></a><a name="li577102311818"></a>Supplementary information about the IP address, IP address range, or CIDR block.</p>
</li><li id="vpc_apiv3_0023__li47716239810"><p id="vpc_apiv3_0023__p107711231083"><a name="vpc_apiv3_0023__li47716239810"></a><a name="li47716239810"></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 class="tablenoborder"><a name="vpc_apiv3_0023__response_PageInfo"></a><a name="response_PageInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0023__response_PageInfo" frame="border" border="1" rules="all"><caption><b>Table 7 </b>PageInfo</caption><thead align="left"><tr id="vpc_apiv3_0023__row197712310817"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="vpc_apiv3_0023__p47813232817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="vpc_apiv3_0023__p18785231481">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="vpc_apiv3_0023__p07819231816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0023__row137782311817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="vpc_apiv3_0023__p278122317816">previous_marker</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="vpc_apiv3_0023__p1978182318810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><ul id="vpc_apiv3_0023__ul13783231816"><li id="vpc_apiv3_0023__li11781123286"><p id="vpc_apiv3_0023__p1781923883"><a name="vpc_apiv3_0023__li11781123286"></a><a name="li11781123286"></a>Definition: The first record on the current page.</p>
</li><li id="vpc_apiv3_0023__li578423287"><p id="vpc_apiv3_0023__p178152314812"><a name="vpc_apiv3_0023__li578423287"></a><a name="li578423287"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0023__row117713233817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="vpc_apiv3_0023__p18781523680">current_count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="vpc_apiv3_0023__p778162314813">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><ul id="vpc_apiv3_0023__ul167813231787"><li id="vpc_apiv3_0023__li127882313816"><p id="vpc_apiv3_0023__p2789236819"><a name="vpc_apiv3_0023__li127882313816"></a><a name="li127882313816"></a>Definition: Total number of records on the current page.</p>
</li><li id="vpc_apiv3_0023__li878112320810"><p id="vpc_apiv3_0023__p13781923482"><a name="vpc_apiv3_0023__li878112320810"></a><a name="li878112320810"></a>Range: None</p>
</li></ul>
</td>
</tr>
<tr id="vpc_apiv3_0023__row117782315817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="vpc_apiv3_0023__p3785232812">next_marker</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="vpc_apiv3_0023__p18791323782">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><ul id="vpc_apiv3_0023__ul197914231889"><li id="vpc_apiv3_0023__li77962320811"><p id="vpc_apiv3_0023__p107962316820"><a name="vpc_apiv3_0023__li77962320811"></a><a name="li77962320811"></a>Definition: The last record on the current page. The parameter <strong id="vpc_apiv3_0023__b2791923185">next_marker</strong> does not exist if the page is the last one.</p>
</li><li id="vpc_apiv3_0023__li167919231787"><p id="vpc_apiv3_0023__p1479523689"><a name="vpc_apiv3_0023__li167919231787"></a><a name="li167919231787"></a>Range: None</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_apiv3_0023__section37982317812"><h4 class="sectiontitle">Example Requests</h4><p id="vpc_apiv3_0023__p9796232818">Query address groups based on combined filter criteria.</p>
<pre class="screen" id="vpc_apiv3_0023__screen19791023982">GET https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups?name=vkvgykvsvhjaaaa1&amp;description=xxxxxxxxxx&amp;ip_version=4</pre>
</div>
<div class="section" id="vpc_apiv3_0023__section9791623686"><h4 class="sectiontitle">Example Responses</h4><p id="vpc_apiv3_0023__p779142310817"><strong id="vpc_apiv3_0023__b47982312819">Status code: 200</strong></p>
<p id="vpc_apiv3_0023__p779102318814">Normal response to the GET operation. For more status codes, see <a href="vpc_api_0002.html">Status Codes</a>.</p>
<pre class="screen" id="vpc_apiv3_0023__screen6191112313815">{
  "address_groups" : [ {
    "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" : [ ]
  } ],
  "page_info" : {
    "previous_marker" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08",
    "current_count" : 1
  },
  "request_id" : "e51fa17c-3259-4122-afb1-9c03d4ef5408"
}</pre>
</div>
<div class="section" id="vpc_apiv3_0023__section41911123781"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0023__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="vpc_apiv3_0023__row882223789"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="vpc_apiv3_0023__p1119110231984">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="vpc_apiv3_0023__p111911323685">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_apiv3_0023__row8821623888"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="vpc_apiv3_0023__p1019252316819">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="vpc_apiv3_0023__p019216231684">Normal response to the GET 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_0023__section1219214231089"><h4 class="sectiontitle">Error Codes</h4><p id="vpc_apiv3_0023__p131921323185">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>