yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
fad830606118e9aa024a1c2926be1aa4eccc8784
doc-exports/docs/cfw/api-ref/DeleteAddressItem.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

247 lines
17 KiB
HTML
Raw Blame History

<a name="DeleteAddressItem"></a><a name="DeleteAddressItem"></a>
<h1 class="topictitle1">Deleting an Address Group Member</h1>
<div id="body1708331107508"><div class="section" id="DeleteAddressItem__section2741714113017"><h4 class="sectiontitle">Function</h4><p id="DeleteAddressItem__p174914203018">This API is used to delete a member from an address group.</p>
</div>
<div class="section" id="DeleteAddressItem__section11741414133012"><h4 class="sectiontitle">URI</h4><p id="DeleteAddressItem__p57461410301">DELETE /v1/{project_id}/address-items/{item_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressItem__table4754144309" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteAddressItem__row07491410301"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteAddressItem__p675201483016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteAddressItem__p1575161412305">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteAddressItem__p27518144309">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteAddressItem__p1375141473014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressItem__row197418140308"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteAddressItem__p1575214183010">item_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteAddressItem__p175111418307">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteAddressItem__p1675514183010">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteAddressItem__p47616141303">Address group member ID, which can be obtained by calling the <a href="ListAddressItems.html">API for querying address group members</a>. Find the value in <strong id="DeleteAddressItem__b14763142307">data.records.item_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="DeleteAddressItem__row775171413304"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteAddressItem__p17661411305">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteAddressItem__p1276714143018">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteAddressItem__p187617145301">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteAddressItem__p2761314113017">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="DeleteAddressItem__table15761114163017" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="DeleteAddressItem__row77671411309"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="DeleteAddressItem__p137717146308">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="DeleteAddressItem__p1977414183011">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="DeleteAddressItem__p137713148308">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="DeleteAddressItem__p1777181417305">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressItem__row1776114173010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteAddressItem__p577131483012">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteAddressItem__p4776148300">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteAddressItem__p3775140302">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteAddressItem__p877181413016">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="DeleteAddressItem__b177121416308">0</strong>.</p>
</td>
</tr>
<tr id="DeleteAddressItem__row1176121410308"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteAddressItem__p1277101483017">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteAddressItem__p77751416301">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteAddressItem__p1877171443011">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteAddressItem__p1878191415307">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="DeleteAddressItem__section178514103016"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressItem__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="DeleteAddressItem__row3781914133016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteAddressItem__p10784148302">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteAddressItem__p1678414123011">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteAddressItem__p97851414305">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteAddressItem__p978111463017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressItem__row127813142303"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteAddressItem__p127951417304">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteAddressItem__p10790145309">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteAddressItem__p117916142302">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteAddressItem__p879914113020">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="DeleteAddressItem__row138961349302"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteAddressItem__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteAddressItem__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteAddressItem__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteAddressItem__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteAddressItem__section279314183019"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteAddressItem__p117991443011"><strong id="DeleteAddressItem__b187961413018">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressItem__response_DeleteAddressItemResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="DeleteAddressItem__row1479814113016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteAddressItem__p779201415302">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteAddressItem__p38016144301">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteAddressItem__p78071420301">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressItem__row16791514193011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteAddressItem__p78031443017">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteAddressItem__p19808142307">Array of <a href="#DeleteAddressItem__response_AddressItemId">AddressItemId</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteAddressItem__p1880214103015">Delete an address group member ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="DeleteAddressItem__response_AddressItemId"></a><a name="response_AddressItemId"></a><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressItem__response_AddressItemId" frame="border" border="1" rules="all"><caption><b>Table 5 </b>AddressItemId</caption><thead align="left"><tr id="DeleteAddressItem__row10809141300"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="DeleteAddressItem__p9801714143012">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="DeleteAddressItem__p78181413301">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="DeleteAddressItem__p1781714123011">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressItem__row1780214183018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteAddressItem__p3819146307">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteAddressItem__p1781101417306">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteAddressItem__p158141415303">ID of an address group member.</p>
</td>
</tr>
<tr id="DeleteAddressItem__row13805145302"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteAddressItem__p1481414173018">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteAddressItem__p781191493018">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteAddressItem__p12811914193017">Name of an address group member.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteAddressItem__p1981121415308"><strong id="DeleteAddressItem__b12811114123012">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressItem__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="DeleteAddressItem__row158121420309"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="DeleteAddressItem__p782171415306">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="DeleteAddressItem__p68211453016">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="DeleteAddressItem__p188220149304">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressItem__row19811014153015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteAddressItem__p9823146306">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteAddressItem__p0821614173013">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteAddressItem__p1482161473015">Error code.</p>
</td>
</tr>
<tr id="DeleteAddressItem__row1581101419301"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteAddressItem__p168215144302">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteAddressItem__p1682161433015">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteAddressItem__p178219140304">Error description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteAddressItem__section382614163015"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteAddressItem__p11836148306">Delete address group member 65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae from project 9d80d070b6d44942af73c9c3d38e0429.</p>
<pre class="screen" id="DeleteAddressItem__screen15836146308">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items/65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae</pre>
</div>
<div class="section" id="DeleteAddressItem__section15831214193017"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteAddressItem__p4831142304"><strong id="DeleteAddressItem__b13831147304">Status code: 200</strong></p>
<p id="DeleteAddressItem__p88331413019">Return value for deleting an address group member.</p>
<pre class="screen" id="DeleteAddressItem__screen1783161419307">{
"data" : {
"id" : "65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae",
"name" : "test"
}
}</pre>
<p id="DeleteAddressItem__p108315144307"><strong id="DeleteAddressItem__b1783141443012">Status code: 400</strong></p>
<p id="DeleteAddressItem__p4831214123013">Bad Request</p>
<pre class="screen" id="DeleteAddressItem__screen383171413305">{
"error_code" : "CFW.0020016",
"error_msg" : "Incorrect instance status."
}</pre>
</div>
<div class="section" id="DeleteAddressItem__section132054145307"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressItem__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteAddressItem__row494714153011"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteAddressItem__p420591403015">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteAddressItem__p32051514133016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressItem__row1594314153014"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressItem__p18206131419305">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressItem__p1206101414308">Return value for deleting an address group member.</p>
</td>
</tr>
<tr id="DeleteAddressItem__row29419144304"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressItem__p6206171415308">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressItem__p10206131493015">Bad Request</p>
</td>
</tr>
<tr id="DeleteAddressItem__row1894191412308"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressItem__p16206101443017">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressItem__p1420631453018">Unauthorized</p>
</td>
</tr>
<tr id="DeleteAddressItem__row11948146306"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressItem__p9206181473012">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressItem__p1920612143304">Forbidden</p>
</td>
</tr>
<tr id="DeleteAddressItem__row1194514163011"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressItem__p620611419306">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressItem__p19206151410301">Not Found</p>
</td>
</tr>
<tr id="DeleteAddressItem__row119411419306"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressItem__p19206214173015">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressItem__p0206181413305">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteAddressItem__section5206101423018"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteAddressItem__p120617144304">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