doc-exports/docs/evs/api-ref/evs_04_2066.html
zhangyue ccbf63b495 EVS API DOC
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-05-16 09:08:21 +00:00

137 lines
9.7 KiB
HTML

<a name="evs_04_2066"></a><a name="evs_04_2066"></a>
<h1 class="topictitle1">Deleting an EVS Disk</h1>
<div id="body1494051692071"><div class="section" id="evs_04_2066__section10932885"><h4 class="sectiontitle">Function</h4><p id="evs_04_2066__p28165387">This API is used to delete an EVS disk.</p>
</div>
<div class="section" id="evs_04_2066__section31287108"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2066__ul66803900"><li id="evs_04_2066__li64364196">URI format<p id="evs_04_2066__p46117407"><a name="evs_04_2066__li64364196"></a><a name="li64364196"></a>DELETE /v2/{project_id}/volumes/{volume_id}</p>
</li><li id="evs_04_2066__li12403484">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2066__table44522499" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2066__row39474480"><th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_2066__p43316293">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.549999999999997%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_2066__p18958859">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.12%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_2066__p59272617">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2066__row36352712"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2066__p58888592">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2066__p5246632">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46.12%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2066__p22324024">The project ID.</p>
</td>
</tr>
<tr id="evs_04_2066__row66698493"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2066__p33868853">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2066__p59022586">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46.12%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2066__p16100147">The disk ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2066__li327457165218">Request filter parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2066__table114096539515" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2066__row64913538519"><th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="evs_04_2066__p14491115311514">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="evs_04_2066__p54911753125116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="evs_04_2066__p10491105315113">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.45454545454546%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="evs_04_2066__p16491553125110">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2066__row64916530515"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2066__p14491953135112">cascade</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2066__p15491185365111">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2066__p349155345117">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2066__p1941233905911">Whether to delete all the snapshots created for this disk. The default value is <strong id="evs_04_2066__b842352706161355">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2066__section13148517"><h4 class="sectiontitle">Request</h4><p id="evs_04_2066__p13766646174510">The following example shows how to delete a disk and all its snapshots.</p>
<ul id="evs_04_2066__ul28722627"><li id="evs_04_2066__li57177053">Example request<pre class="screen" id="evs_04_2066__screen13806089161140">DELETE https://{endpoint}/v2/{project_id}/volumes/{volume_id}?cascade=true</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2066__section51227795"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2066__ul2889143711911"><li id="evs_04_2066__li15611911911">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2066__table46654279102454" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2066__row6664264102454"><th align="left" class="cellrowborder" valign="top" width="20.24%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_2066__p2934472102454">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.62%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2066__p1338569102927">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2066__p23036595102454">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2066__row12419334102454"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2066__p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2066__p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2066__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2066__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2066__li0419202382514"><a name="evs_04_2066__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2066__evs_04_2013_b1288034833610">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2066__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2066__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_2066__evs_04_2013_p19541716103019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_2066__evs_04_2013_p39375186103019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_2066__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2066__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2066__evs_04_2013_p46815658103019">message</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2066__evs_04_2013_p33971979103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2066__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2066__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2066__evs_04_2013_p59870541103019">code</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2066__evs_04_2013_p17675690103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2066__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_2066__evs_04_2013_p54787218103019">For details about the error code, see <a href="evs_04_0038.html">Error Codes</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2066__li2903350411916">Example response<p id="evs_04_2066__p57112307111233"><a name="evs_04_2066__li2903350411916"></a><a name="li2903350411916"></a>None</p>
<p id="evs_04_2066__p52821068113531">or</p>
<pre class="screen" id="evs_04_2066__screen4594167995947">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_2066__p5655715720175">In the preceding example, <strong id="evs_04_2066__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2066__b842352706144438">badrequest</strong> or <strong id="evs_04_2066__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_2066__screen3690146144318">{
"itemNotFound": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2066__section58396974"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2066__ul2515205"><li id="evs_04_2066__li22636847">Normal<p id="evs_04_2066__p2405037"><a name="evs_04_2066__li22636847"></a><a name="li22636847"></a>202</p>
</li></ul>
</div>
<div class="section" id="evs_04_2066__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2066__evs_04_2013_p783819215242">For details, see <a href="evs_04_0038.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="evs_04_2064.html">Disk Management</a></div>
</div>
</div>