yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
9776db0ee8a683d760113bf6d389063073121b5d
doc-exports/docs/cfw/api-ref/AddAddressItem.html
qiaoli 9776db0ee8 First version of the CFW API 
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qiaoli <qiaoli@huawei.com>
Co-committed-by: qiaoli <qiaoli@huawei.com>
2025-01-21 07:59:01 +00:00

366 lines
25 KiB
HTML
Raw Blame History

<a name="AddAddressItem"></a><a name="AddAddressItem"></a>
<h1 class="topictitle1">Adding an Address Group Member</h1>
<div id="body1708331107508"><div class="section" id="AddAddressItem__section163855783014"><h4 class="sectiontitle">Function</h4><p id="AddAddressItem__p53851378307">This API is used to add a member to an address group.</p>
</div>
<div class="section" id="AddAddressItem__section83863712301"><h4 class="sectiontitle">URI</h4><p id="AddAddressItem__p10387873307">POST /v1/{project_id}/address-items</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AddAddressItem__table13885718301" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="AddAddressItem__row1138757113016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="AddAddressItem__p2388276302">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="AddAddressItem__p19388978308">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="AddAddressItem__p1538987123018">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="AddAddressItem__p19389474304">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AddAddressItem__row23876711307"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="AddAddressItem__p538911783011">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="AddAddressItem__p5390147123010">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="AddAddressItem__p15390157113010">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="AddAddressItem__p539197143011">Project ID, which can be obtained by calling an API or from the console. For details, see <a href="cfw_02_0015.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AddAddressItem__table639115718304" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="AddAddressItem__row16391679309"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="AddAddressItem__p15392137193017">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="AddAddressItem__p15392207193017">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="AddAddressItem__p103921178300">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="AddAddressItem__p103934712306">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AddAddressItem__row133915720301"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="AddAddressItem__p33939714308">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="AddAddressItem__p163943713303">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="AddAddressItem__p183945716300">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="AddAddressItem__p10394672301">Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to <a href="cfw_02_0027.html">Obtaining an Enterprise Project ID</a>. If the enterprise project function is not enabled, the value is <strong id="AddAddressItem__b1239567193017">0</strong>.</p>
</td>
</tr>
<tr id="AddAddressItem__row193914763010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="AddAddressItem__p23951071301">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="AddAddressItem__p13395171304">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="AddAddressItem__p039614723011">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="AddAddressItem__p7396187163011">Firewall ID, which can be obtained by referring to <a href="cfw_02_0028.html">Obtaining a Firewall ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="AddAddressItem__section63963716306"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AddAddressItem__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="AddAddressItem__row12397197103013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="AddAddressItem__p63986718308">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="AddAddressItem__p439819753019">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="AddAddressItem__p7398147193015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="AddAddressItem__p153996717308">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AddAddressItem__row03974717306"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="AddAddressItem__p203997710307">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="AddAddressItem__p9400374300">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="AddAddressItem__p3400273305">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="AddAddressItem__p34007718305">User token. You can obtain the token by referring to <a href="cfw_02_0029.html">Obtaining a User Token</a>.</p>
</td>
</tr>
<tr id="AddAddressItem__row1783062353015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="AddAddressItem__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="AddAddressItem__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="AddAddressItem__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="AddAddressItem__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AddAddressItem__request_AddAddressItemsInfoDto" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request body parameters</caption><thead align="left"><tr id="AddAddressItem__row1940114763016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="AddAddressItem__p84028793010">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="AddAddressItem__p1640297173019">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="AddAddressItem__p13402117163018">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="AddAddressItem__p240315773010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AddAddressItem__row184018717308"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="AddAddressItem__p74031978309">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="AddAddressItem__p240310743018">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="AddAddressItem__p54045703016">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="AddAddressItem__p144043715307">Address group ID, which can be obtained by calling the <a href="ListAddressSets.html">API for querying the address group list</a>. Find the value in <strong id="AddAddressItem__b1940537103017">data.records.set_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="AddAddressItem__row0401272306"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="AddAddressItem__p240514743014">address_items</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="AddAddressItem__p184053743018">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="AddAddressItem__p194061872309">Array of <a href="#AddAddressItem__request_address_items">address_items</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="AddAddressItem__p14068713308">Address group member list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="AddAddressItem__request_address_items"></a><a name="request_address_items"></a><table cellpadding="4" cellspacing="0" summary="" id="AddAddressItem__request_address_items" frame="border" border="1" rules="all"><caption><b>Table 5 </b>address_items</caption><thead align="left"><tr id="AddAddressItem__row124065733017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="AddAddressItem__p1407579304">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="AddAddressItem__p740814763017">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="AddAddressItem__p640837133016">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="AddAddressItem__p1340847183017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AddAddressItem__row240697183015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="AddAddressItem__p104091276307">address_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="AddAddressItem__p114097723019">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="AddAddressItem__p14099763015">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="AddAddressItem__p341047103018">Address type: <strong id="AddAddressItem__b1241014713011">0</strong> (IPv4), <strong id="AddAddressItem__b441016793019">1</strong> (IPv6).</p>
</td>
</tr>
<tr id="AddAddressItem__row1040617123011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="AddAddressItem__p1941013773015">address</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="AddAddressItem__p24112773014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="AddAddressItem__p1941113723011">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="AddAddressItem__p741110716305">ip</p>
</td>
</tr>
<tr id="AddAddressItem__row174061879307"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="AddAddressItem__p1441212716301">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="AddAddressItem__p15412273305">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="AddAddressItem__p1741213716305">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="AddAddressItem__p104139715303">Address group member description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="AddAddressItem__section19413875306"><h4 class="sectiontitle">Response Parameters</h4><p id="AddAddressItem__p84142733020"><strong id="AddAddressItem__b1041420733015">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AddAddressItem__response_AddAddressItemsResponse" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="AddAddressItem__row17414127133013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="AddAddressItem__p124154743016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="AddAddressItem__p641557113014">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="AddAddressItem__p1741610713011">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AddAddressItem__row154141571306"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="AddAddressItem__p141616733010">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="AddAddressItem__p341767103016"><a href="#AddAddressItem__response_AddressItems">AddressItems</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="AddAddressItem__p1341727193017">Data returned after an address group member is added.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="AddAddressItem__response_AddressItems"></a><a name="response_AddressItems"></a><table cellpadding="4" cellspacing="0" summary="" id="AddAddressItem__response_AddressItems" frame="border" border="1" rules="all"><caption><b>Table 7 </b>AddressItems</caption><thead align="left"><tr id="AddAddressItem__row1641887113018"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="AddAddressItem__p141920720308">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="AddAddressItem__p154191375305">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="AddAddressItem__p1141947193019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AddAddressItem__row641820717300"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AddAddressItem__p1942013753013">items</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AddAddressItem__p11420471301">Array of <a href="#AddAddressItem__response_AddressItemIdWithoutName">AddressItemIdWithoutName</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AddAddressItem__p442112713015">List of address group member IDs.</p>
</td>
</tr>
<tr id="AddAddressItem__row94181177308"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="AddAddressItem__p1742197173015">covered_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="AddAddressItem__p542137123010">Array of <a href="#AddAddressItem__response_CoveredIPVO">CoveredIPVO</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="AddAddressItem__p14422137153014">List of covered IP addresses.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="AddAddressItem__response_AddressItemIdWithoutName"></a><a name="response_AddressItemIdWithoutName"></a><table cellpadding="4" cellspacing="0" summary="" id="AddAddressItem__response_AddressItemIdWithoutName" frame="border" border="1" rules="all"><caption><b>Table 8 </b>AddressItemIdWithoutName</caption><thead align="left"><tr id="AddAddressItem__row1442213716307"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="AddAddressItem__p24231073306">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="AddAddressItem__p6423147193017">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="AddAddressItem__p104243720303">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AddAddressItem__row14223743013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="AddAddressItem__p942457103013">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="AddAddressItem__p18424479305">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="AddAddressItem__p842587133012">ID of an address group member.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="AddAddressItem__response_CoveredIPVO"></a><a name="response_CoveredIPVO"></a><table cellpadding="4" cellspacing="0" summary="" id="AddAddressItem__response_CoveredIPVO" frame="border" border="1" rules="all"><caption><b>Table 9 </b>CoveredIPVO</caption><thead align="left"><tr id="AddAddressItem__row642597133013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="AddAddressItem__p1642637123019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="AddAddressItem__p1442611753014">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="AddAddressItem__p742716715308">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AddAddressItem__row04251777304"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="AddAddressItem__p104271763013">ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="AddAddressItem__p194273713302">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="AddAddressItem__p1242819720304">IP address</p>
</td>
</tr>
<tr id="AddAddressItem__row54256711301"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="AddAddressItem__p15428157203018">covered_Ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="AddAddressItem__p342811713301">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="AddAddressItem__p174299793010">Cover an IP address.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="AddAddressItem__p942912716301"><strong id="AddAddressItem__b94297723012">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AddAddressItem__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="AddAddressItem__row1142937183014"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="AddAddressItem__p104306773010">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="AddAddressItem__p643010713019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="AddAddressItem__p5431278307">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AddAddressItem__row1642915713308"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="AddAddressItem__p14316753016">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="AddAddressItem__p343216717306">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="AddAddressItem__p1243237153018">Error code.</p>
</td>
</tr>
<tr id="AddAddressItem__row642913712301"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="AddAddressItem__p1643217153012">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="AddAddressItem__p14330720302">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="AddAddressItem__p144334713019">Error description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="AddAddressItem__section643311713012"><h4 class="sectiontitle">Example Requests</h4><p id="AddAddressItem__p114346733012">Add an address group member whose IP address is 2.2.2.2 and name is <strong id="AddAddressItem__b144345715306">ceshi</strong> to the group whose <strong id="AddAddressItem__b34346720302">set_id</strong> is 8773c082-2a6c-4529-939a-edc28ef1a67c in project 9d80d070b6d44942af73c9c3d38e0429.</p>
<pre class="screen" id="AddAddressItem__screen13435272304">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items
{
"set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c",
"address_items" : [ {
"description" : "",
"address" : "2.2.2.2"
} ]
}</pre>
</div>
<div class="section" id="AddAddressItem__section174371716305"><h4 class="sectiontitle">Example Responses</h4><p id="AddAddressItem__p1643817173010"><strong id="AddAddressItem__b18438107133018">Status code: 200</strong></p>
<p id="AddAddressItem__p74381173305">Return value for adding an address group member.</p>
<pre class="screen" id="AddAddressItem__screen343917173020">{
"data" : {
"covered_ip" : [ ],
"items" : [ {
"id" : "65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae"
} ]
}
}</pre>
<p id="AddAddressItem__p14441773307"><strong id="AddAddressItem__b194411733017">Status code: 400</strong></p>
<p id="AddAddressItem__p644112717309">Bad Request</p>
<pre class="screen" id="AddAddressItem__screen15441376306">{
"error_code" : "CFW.00200001",
"error_msg" : "Empty parameter."
}</pre>
</div>
<div class="section" id="AddAddressItem__section2059427123014"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AddAddressItem__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="AddAddressItem__row1748215753016"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="AddAddressItem__p11595377303">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="AddAddressItem__p10595117133018">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="AddAddressItem__row34829714309"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="AddAddressItem__p13595179308">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="AddAddressItem__p85951978304">Return value for adding an address group member.</p>
</td>
</tr>
<tr id="AddAddressItem__row19482107113017"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="AddAddressItem__p759557193010">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="AddAddressItem__p105952070300">Bad Request</p>
</td>
</tr>
<tr id="AddAddressItem__row1048247173010"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="AddAddressItem__p55953773014">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="AddAddressItem__p1559537123016">Unauthorized</p>
</td>
</tr>
<tr id="AddAddressItem__row2048217723012"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="AddAddressItem__p75951378307">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="AddAddressItem__p959567103018">Forbidden</p>
</td>
</tr>
<tr id="AddAddressItem__row348237133019"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="AddAddressItem__p155965713307">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="AddAddressItem__p155962719309">Not Found</p>
</td>
</tr>
<tr id="AddAddressItem__row348247203015"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="AddAddressItem__p14596117193020">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="AddAddressItem__p10596107143015">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="AddAddressItem__section55967713013"><h4 class="sectiontitle">Error Codes</h4><p id="AddAddressItem__p15963720309">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Address Group Management</a></div>
</div>
</div>
View Git Blame Copy Permalink