vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/bms/api-ref/en-us_topic_0191726734.html
guoyanyan c311ecafe3 bms_api_0510 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
2023-10-11 08:28:11 +00:00

139 lines
12 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0191726734"></a><a name="EN-US_TOPIC_0191726734"></a>
<h1 class="topictitle1">Deleting <span id="text266731472811">BMS</span><span id="text7802430369"></span><span id="text549771912419"></span>s</h1>
<div id="body1568169719267"><div class="section" id="EN-US_TOPIC_0191726734__section61511739"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0191726734__p66929645">This API is used to delete specified <span id="EN-US_TOPIC_0191726734__text1952312863619">BMS</span><span id="EN-US_TOPIC_0191726734__text3667131420286"></span>s in a batch or one by one.</p>
</div>
<div class="section" id="EN-US_TOPIC_0191726734__section8849536152"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0191726734__ul113169711618"><li id="EN-US_TOPIC_0191726734__li831614712612">This API can only be used to delete pay-per-use BMSs.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0191726734__section16734741"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0191726734__p50237013152238">POST /v1/{project_id}/baremetalservers/delete</p>
<div class="p" id="EN-US_TOPIC_0191726734__p12932412153511"><a href="#EN-US_TOPIC_0191726734__table52652517">Table 1</a> lists the parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0191726734__table52652517"></a><a name="table52652517"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0191726734__table52652517" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0191726734__row61945077"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.3.2.2.4.1.1"><p id="EN-US_TOPIC_0191726734__p51495331">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.3.2.2.4.1.2"><p id="EN-US_TOPIC_0191726734__p10372286">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.3.2.2.4.1.3"><p id="EN-US_TOPIC_0191726734__p34848813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0191726734__row4181593"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0191726734__p3164713">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0191726734__p55015173">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0191726734__p37593705">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0191726734__p104071351104210">For details about how to obtain the project ID, see <a href="en-us_topic_0171277624.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0191726734__section16394943"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0191726734__ul52218921"><li id="EN-US_TOPIC_0191726734__li15842189">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0191726734__table8361976" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0191726734__row2187155"><th align="left" class="cellrowborder" valign="top" width="19.61%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="EN-US_TOPIC_0191726734__p42941906">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.07%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="EN-US_TOPIC_0191726734__p55742394">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.61%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0191726734__p18840050">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.71%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0191726734__p49649058">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0191726734__row62150771"><td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0191726734__p1047692">servers</p>
</td>
<td class="cellrowborder" valign="top" width="19.07%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0191726734__p17754262">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0191726734__p28809145">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="41.71%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0191726734__p63901309">Specifies the BMSs to be deleted. For details, see <a href="#EN-US_TOPIC_0191726734__table32603030">Table 2</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0191726734__row38240871"><td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0191726734__p10502851">delete_publicip</p>
</td>
<td class="cellrowborder" valign="top" width="19.07%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0191726734__p45424599">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0191726734__p55513932">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="41.71%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0191726734__p334666">Specifies whether to delete the EIP bound to the BMS when the BMS is deleted. If you choose not to delete the EIP, the system only unbinds the EIP from the BMS and reserves the EIP.</p>
<p id="EN-US_TOPIC_0191726734__p3011995">The value can be <strong id="EN-US_TOPIC_0191726734__b842352706184734">true</strong> or <strong id="EN-US_TOPIC_0191726734__b842352706184738">false</strong>. The default value is <strong id="EN-US_TOPIC_0191726734__b842352706184742">false</strong>.</p>
<ul id="EN-US_TOPIC_0191726734__ul11598244152333"><li id="EN-US_TOPIC_0191726734__li43443640152333"><strong id="EN-US_TOPIC_0191726734__b842352706161021">true</strong>: The EIP bound to the BMS is deleted when the BMS is deleted.</li><li id="EN-US_TOPIC_0191726734__li22382180152333"><strong id="EN-US_TOPIC_0191726734__b27663993416118">false</strong>: The EIP is unbound from the BMS when the BMS is deleted, but not deleted.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0191726734__row27107960"><td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0191726734__p48261118">delete_volume</p>
</td>
<td class="cellrowborder" valign="top" width="19.07%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0191726734__p16836485">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0191726734__p21578036">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="41.71%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0191726734__p2990516">Specifies whether to delete a data disk attached to the BMS when the BMS is deleted. If you choose not to delete the data disk, the system only detaches the disk from the BMS and reserves the disk.</p>
<p id="EN-US_TOPIC_0191726734__p26914650">The value can be <strong id="EN-US_TOPIC_0191726734__b1371090306">true</strong> or <strong id="EN-US_TOPIC_0191726734__b509507852">false</strong>. The default value is <strong id="EN-US_TOPIC_0191726734__b1418238436">false</strong>.</p>
<ul id="EN-US_TOPIC_0191726734__ul48071530152411"><li id="EN-US_TOPIC_0191726734__li29990588152411"><strong id="EN-US_TOPIC_0191726734__b962011343">true</strong>: The data disk attached to the BMS is deleted when the BMS is deleted.</li><li id="EN-US_TOPIC_0191726734__li1479838152411"><strong id="EN-US_TOPIC_0191726734__b505974657161155">false</strong>: The data disk is detached from the BMS when the BMS is deleted, but not deleted.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0191726734__table32603030"></a><a name="table32603030"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0191726734__table32603030" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0191726734__b169421118919">servers</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0191726734__row25141347"><th align="left" class="cellrowborder" valign="top" width="19.72%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0191726734__p23183246">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.18%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0191726734__p65903650">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.61%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0191726734__p36595397">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.49%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0191726734__p11437218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0191726734__row53999455"><td class="cellrowborder" valign="top" width="19.72%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0191726734__p11879716">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.18%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0191726734__p22732954">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0191726734__p29429992">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.49%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0191726734__p35019191">Specifies the ID of the BMS to be deleted.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0191726734__li13713101619588">Example request<pre class="screen" id="EN-US_TOPIC_0191726734__screen63926254143245">{
"servers": [
{
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
}
],
"delete_publicip": false,
"delete_volume": false
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0191726734__section13336762"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0191726734__p27622569">See <a href="en-us_topic_0131356399.html">Task ID Response</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0191726734__section12571834"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0191726734__p87369529318">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0191726734__table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0191726734__row10735134615172"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.6.2.1.1.3.1.1"><p id="EN-US_TOPIC_0191726734__p19735204616177">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.6.2.1.1.3.1.2"><p id="EN-US_TOPIC_0191726734__p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0191726734__row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0191726734__p13735144611178">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0191726734__p81516575011">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0191726734__p47633965">For details about other returned values, see <a href="en-us_topic_0053158690.html">Status Codes</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0191726734__section85821649202813"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0191726734__p7233105282813">See <a href="en-us_topic_0107541808.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0113746488.html">BMS Lifecycle Management</a></div>
</div>
</div>
View Git Blame Copy Permalink