forked from docs/doc-exports
fanqinying
05458809ab
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>
302 lines
24 KiB
HTML
302 lines
24 KiB
HTML
<a name="vpc_apiv3_0024"></a><a name="vpc_apiv3_0024"></a>
|
|
|
|
<h1 class="topictitle1">Querying an IP Address Group</h1>
|
|
<div id="body1708331107508"><div class="section" id="vpc_apiv3_0024__section965318261994"><h4 class="sectiontitle">Function</h4><p id="vpc_apiv3_0024__p13654726597">This API is used to query the details of an IP address group.</p>
|
|
</div>
|
|
<div class="section" id="vpc_apiv3_0024__section20654142613914"><h4 class="sectiontitle">URI</h4><p id="vpc_apiv3_0024__p1265432610919">GET /v3/{project_id}/vpc/address-groups/{address_group_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0024__table965418261494" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="vpc_apiv3_0024__row19654626294"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="vpc_apiv3_0024__p76542262916">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_0024__p176555263913">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_0024__p1265592613912">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_0024__p17655426690">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_apiv3_0024__row76541826792"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="vpc_apiv3_0024__p2065518261591">address_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="vpc_apiv3_0024__p7655162610910">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="vpc_apiv3_0024__p665542611919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="vpc_apiv3_0024__p106551026793">IP address group ID that uniquely identifies the IP address group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiv3_0024__row186540265913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="vpc_apiv3_0024__p146551226596">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="vpc_apiv3_0024__p19655182610917">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="vpc_apiv3_0024__p156559262915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="vpc_apiv3_0024__p17655226294">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_apiv3_0024__section1655152617916"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_apiv3_0024__p265592610911">None</p>
|
|
</div>
|
|
<div class="section" id="vpc_apiv3_0024__section06557264910"><h4 class="sectiontitle">Response Parameters</h4><p id="vpc_apiv3_0024__p1965517262099"><strong id="vpc_apiv3_0024__b56550263916">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0024__response_ShowAddressGroupResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="vpc_apiv3_0024__row36561926794"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="vpc_apiv3_0024__p665672617920">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_0024__p1665662613919">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_0024__p1965617261496">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_apiv3_0024__row1465618266915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_apiv3_0024__p9656126390">request_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_apiv3_0024__p1665619262914">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_apiv3_0024__p11656152619918">Request ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiv3_0024__row5656726797"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="vpc_apiv3_0024__p136566261092">address_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="vpc_apiv3_0024__p1065682618918"><a href="#vpc_apiv3_0024__response_AddressGroup">AddressGroup</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="vpc_apiv3_0024__p7656926097">Response body for querying an IP address group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_apiv3_0024__response_AddressGroup"></a><a name="response_AddressGroup"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0024__response_AddressGroup" frame="border" border="1" rules="all"><caption><b>Table 3 </b>AddressGroup</caption><thead align="left"><tr id="vpc_apiv3_0024__row965720261892"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="vpc_apiv3_0024__p1765813261791">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_0024__p1465819261692">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_0024__p0658172619911">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_apiv3_0024__row665711266912"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0024__p176585261493">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0024__p126583261199">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0024__ul5658826499"><li id="vpc_apiv3_0024__li665811261396"><p id="vpc_apiv3_0024__p16658126396"><a name="vpc_apiv3_0024__li665811261396"></a><a name="li665811261396"></a>IP address group ID that uniquely identifies the IP address group.</p>
|
|
</li><li id="vpc_apiv3_0024__li1265816261493"><p id="vpc_apiv3_0024__p665812261997"><a name="vpc_apiv3_0024__li1265816261493"></a><a name="li1265816261493"></a>The value is a string in UUID format.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiv3_0024__row1657142614912"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0024__p1165819262919">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0024__p86586261193">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0024__ul4658226792"><li id="vpc_apiv3_0024__li865862610912"><p id="vpc_apiv3_0024__p1265872610915"><a name="vpc_apiv3_0024__li865862610912"></a><a name="li865862610912"></a>IP address group name.</p>
|
|
</li><li id="vpc_apiv3_0024__li126581426994"><p id="vpc_apiv3_0024__p1658726297"><a name="vpc_apiv3_0024__li126581426994"></a><a name="li126581426994"></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_0024__row96578267920"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0024__p56591126493">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0024__p965915266917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0024__ul1265920262090"><li id="vpc_apiv3_0024__li96595261491"><p id="vpc_apiv3_0024__p116591026592"><a name="vpc_apiv3_0024__li96595261491"></a><a name="li96595261491"></a>Description about the IP address group.</p>
|
|
</li><li id="vpc_apiv3_0024__li1165916261918"><p id="vpc_apiv3_0024__p5659726294"><a name="vpc_apiv3_0024__li1165916261918"></a><a name="li1165916261918"></a>The value can contain no more than 255 characters.</p>
|
|
</li><li id="vpc_apiv3_0024__li7659426895"><p id="vpc_apiv3_0024__p765918261698"><a name="vpc_apiv3_0024__li7659426895"></a><a name="li7659426895"></a>The value cannot contain angle brackets (< or >).</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiv3_0024__row86571261897"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0024__p56597261895">ip_set</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0024__p96596267918">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_0024__ul665919262919"><li id="vpc_apiv3_0024__li16599261294"><p id="vpc_apiv3_0024__p116591626199"><a name="vpc_apiv3_0024__li16599261294"></a><a name="li16599261294"></a>IP address sets in an IP address group.</p>
|
|
</li><li id="vpc_apiv3_0024__li165962611916"><p id="vpc_apiv3_0024__p116601261296"><a name="vpc_apiv3_0024__li165962611916"></a><a name="li165962611916"></a>The value can be a single IP address, IP address range, or CIDR block.</p>
|
|
</li><li id="vpc_apiv3_0024__li16601261998"><p id="vpc_apiv3_0024__p13660152612919"><a name="vpc_apiv3_0024__li16601261998"></a><a name="li16601261998"></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_0024__row1765722614918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0024__p15660112614910">ip_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0024__p176601263915">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0024__ul16608261094"><li id="vpc_apiv3_0024__li146601260918"><p id="vpc_apiv3_0024__p17660126792"><a name="vpc_apiv3_0024__li146601260918"></a><a name="li146601260918"></a>Whether it is an IPv4 or IPv6 address group.</p>
|
|
</li><li id="vpc_apiv3_0024__li11660172613916"><p id="vpc_apiv3_0024__p136606261895"><a name="vpc_apiv3_0024__li11660172613916"></a><a name="li11660172613916"></a>The value can be one of the following:</p>
|
|
<ul id="vpc_apiv3_0024__ul466015261190"><li id="vpc_apiv3_0024__li1466013261193"><p id="vpc_apiv3_0024__p466018261912"><a name="vpc_apiv3_0024__li1466013261193"></a><a name="li1466013261193"></a><strong id="vpc_apiv3_0024__b1566032612919">4</strong> (IPv4 address groups).</p>
|
|
</li><li id="vpc_apiv3_0024__li46602261094"><p id="vpc_apiv3_0024__p266011262915"><a name="vpc_apiv3_0024__li46602261094"></a><a name="li46602261094"></a><strong id="vpc_apiv3_0024__b7660172615915">6</strong> (IPv6 address groups).</p>
|
|
</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiv3_0024__row5657182613913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0024__p066019264914">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0024__p36601726195">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0024__ul766020262911"><li id="vpc_apiv3_0024__li19660126691"><p id="vpc_apiv3_0024__p66601826495"><a name="vpc_apiv3_0024__li19660126691"></a><a name="li19660126691"></a>Time when the IP address group was created.</p>
|
|
</li><li id="vpc_apiv3_0024__li5661626890"><p id="vpc_apiv3_0024__p19661726894"><a name="vpc_apiv3_0024__li5661626890"></a><a name="li5661626890"></a>The value is a UTC time in the format of <em id="vpc_apiv3_0024__i17661112614913">yyyy-MM-ddTHH:mm:ss</em>, which is automatically generated by the system.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiv3_0024__row765711261992"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0024__p9661126891">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0024__p1066110261898">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0024__ul166182617920"><li id="vpc_apiv3_0024__li26611926891"><p id="vpc_apiv3_0024__p1066115269916"><a name="vpc_apiv3_0024__li26611926891"></a><a name="li26611926891"></a>Time when the IP address group was last updated.</p>
|
|
</li><li id="vpc_apiv3_0024__li13661122610912"><p id="vpc_apiv3_0024__p46611526195"><a name="vpc_apiv3_0024__li13661122610912"></a><a name="li13661122610912"></a>The value is a UTC time in the format of <em id="vpc_apiv3_0024__i1666110261396">yyyy-MM-ddTHH:mm:ss</em>, which is automatically generated by the system.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiv3_0024__row86570261590"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0024__p156611626391">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="vpc_apiv3_0024__p1466114261915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="vpc_apiv3_0024__ul366118260918"><li id="vpc_apiv3_0024__li46611126391"><p id="vpc_apiv3_0024__p0661426193"><a name="vpc_apiv3_0024__li46611126391"></a><a name="li46611126391"></a>ID of the project where the IP address group is used.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_apiv3_0024__row3657026592"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="vpc_apiv3_0024__p1866316261194">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_0024__p266317261499">Array of <a href="#vpc_apiv3_0024__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_0024__ul186631526598"><li id="vpc_apiv3_0024__li1663172613916"><p id="vpc_apiv3_0024__p126638266919"><a name="vpc_apiv3_0024__li1663172613916"></a><a name="li1663172613916"></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_0024__response_ResponseTag" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ResponseTag</caption><thead align="left"><tr id="vpc_apiv3_0024__row566332618916"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="vpc_apiv3_0024__p1766414260916">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_0024__p1266412261920">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_0024__p186645267914">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_apiv3_0024__row1466312615916"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="vpc_apiv3_0024__p116640261499">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="vpc_apiv3_0024__p7664192617916">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><ul id="vpc_apiv3_0024__ul3585326104"><li id="vpc_apiv3_0024__li145851921103"><p id="vpc_apiv3_0024__p65857241011"><a name="vpc_apiv3_0024__li145851921103"></a><a name="li145851921103"></a>Definition: Tag key.</p>
|
|
</li><li id="vpc_apiv3_0024__li4585622108"><p id="vpc_apiv3_0024__p158592191010"><a name="vpc_apiv3_0024__li4585622108"></a><a name="li4585622108"></a>Range:</p>
|
|
<ul id="vpc_apiv3_0024__ul1058511241010"><li id="vpc_apiv3_0024__li0585102141010"><p id="vpc_apiv3_0024__p1158519211011"><a name="vpc_apiv3_0024__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_0024__li155853212101"><p id="vpc_apiv3_0024__p185857291017"><a name="vpc_apiv3_0024__li155853212101"></a><a name="li155853212101"></a>Each key value of a resource must be unique.</p>
|
|
</li><li id="vpc_apiv3_0024__li3585025105"><p id="vpc_apiv3_0024__p2586102171014"><a name="vpc_apiv3_0024__li3585025105"></a><a name="li3585025105"></a>The value can contain:</p>
|
|
<ul id="vpc_apiv3_0024__ul1358618271019"><li id="vpc_apiv3_0024__li658611215104"><p id="vpc_apiv3_0024__p17586192201013"><a name="vpc_apiv3_0024__li658611215104"></a><a name="li658611215104"></a>Letters</p>
|
|
</li><li id="vpc_apiv3_0024__li6586102191017"><p id="vpc_apiv3_0024__p658616271010"><a name="vpc_apiv3_0024__li6586102191017"></a><a name="li6586102191017"></a>Digits</p>
|
|
</li><li id="vpc_apiv3_0024__li758619218107"><p id="vpc_apiv3_0024__p558618214106"><a name="vpc_apiv3_0024__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_0024__row266315261898"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="vpc_apiv3_0024__p156658265920">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="vpc_apiv3_0024__p1366552611910">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><ul id="vpc_apiv3_0024__ul10586625104"><li id="vpc_apiv3_0024__li7586172161016"><p id="vpc_apiv3_0024__p7586102121011"><a name="vpc_apiv3_0024__li7586172161016"></a><a name="li7586172161016"></a>Definition: Tag value.</p>
|
|
</li><li id="vpc_apiv3_0024__li458612213107"><p id="vpc_apiv3_0024__p185861261014"><a name="vpc_apiv3_0024__li458612213107"></a><a name="li458612213107"></a>Range:</p>
|
|
<ul id="vpc_apiv3_0024__ul1058622161018"><li id="vpc_apiv3_0024__li35861222107"><p id="vpc_apiv3_0024__p19586722108"><a name="vpc_apiv3_0024__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_0024__li45861423105"><p id="vpc_apiv3_0024__p55864231017"><a name="vpc_apiv3_0024__li45861423105"></a><a name="li45861423105"></a>The value can contain:</p>
|
|
<ul id="vpc_apiv3_0024__ul13586102131015"><li id="vpc_apiv3_0024__li85865271019"><p id="vpc_apiv3_0024__p1958632151014"><a name="vpc_apiv3_0024__li85865271019"></a><a name="li85865271019"></a>Letters</p>
|
|
</li><li id="vpc_apiv3_0024__li758613211016"><p id="vpc_apiv3_0024__p458617211106"><a name="vpc_apiv3_0024__li758613211016"></a><a name="li758613211016"></a>Digits</p>
|
|
</li><li id="vpc_apiv3_0024__li1758614241017"><p id="vpc_apiv3_0024__p135867215104"><a name="vpc_apiv3_0024__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_0024__response_IpExtraSetRespOption"></a><a name="response_IpExtraSetRespOption"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0024__response_IpExtraSetRespOption" frame="border" border="1" rules="all"><caption><b>Table 5 </b>IpExtraSetRespOption</caption><thead align="left"><tr id="vpc_apiv3_0024__row1166515262099"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="vpc_apiv3_0024__p15666426395">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_0024__p566617261913">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_0024__p1866617261591">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_apiv3_0024__row7665426596"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="vpc_apiv3_0024__p126662269915">ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="vpc_apiv3_0024__p116663261696">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><ul id="vpc_apiv3_0024__ul26661726798"><li id="vpc_apiv3_0024__li116663266913"><p id="vpc_apiv3_0024__p206661826595"><a name="vpc_apiv3_0024__li116663266913"></a><a name="li116663266913"></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_0024__row666572618913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="vpc_apiv3_0024__p18666172611915">remarks</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="vpc_apiv3_0024__p1766662615911">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><ul id="vpc_apiv3_0024__ul196665266910"><li id="vpc_apiv3_0024__li1666617261914"><p id="vpc_apiv3_0024__p66663261193"><a name="vpc_apiv3_0024__li1666617261914"></a><a name="li1666617261914"></a>Supplementary information about the IP address, IP address range, or CIDR block.</p>
|
|
</li><li id="vpc_apiv3_0024__li566617260913"><p id="vpc_apiv3_0024__p1666102618917"><a name="vpc_apiv3_0024__li566617260913"></a><a name="li566617260913"></a>The value can contain no more than 255 characters and cannot contain angle brackets (< or >).</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_apiv3_0024__section166610262918"><h4 class="sectiontitle">Example Requests</h4><p id="vpc_apiv3_0024__p066612261590">Querying the details of an IP address group</p>
|
|
<pre class="screen" id="vpc_apiv3_0024__screen16662262096">GET https://{Endpoint}/v3/2bc7a67b35a64a79ad1d3bb8b5f61fc9/vpc/address-groups/dd18a501-fcd5-4adc-acfe-b0e2384baf08</pre>
|
|
</div>
|
|
<div class="section" id="vpc_apiv3_0024__section766714261792"><h4 class="sectiontitle">Example Responses</h4><p id="vpc_apiv3_0024__p136671826994"><strong id="vpc_apiv3_0024__b116679262912">Status code: 200</strong></p>
|
|
<p id="vpc_apiv3_0024__p19667226799">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_0024__screen116678261495">{
|
|
"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" : "10.10.4.0/23",
|
|
"status" : "NORMAL",
|
|
"status_message" : "",
|
|
"tags" : [ ]
|
|
},
|
|
"request_id" : "ce6c359b-9002-41e5-a0b1-232759bd6637"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="vpc_apiv3_0024__section126689266913"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_apiv3_0024__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="vpc_apiv3_0024__row1866882615918"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="vpc_apiv3_0024__p266816261913">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_0024__p12668102620918">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_apiv3_0024__row56685261894"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="vpc_apiv3_0024__p16668152617915">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="vpc_apiv3_0024__p206699261599">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_0024__section126691426797"><h4 class="sectiontitle">Error Codes</h4><p id="vpc_apiv3_0024__p06695261092">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>
|
|
|