forked from docs/doc-exports
zhangyue
f3b09e5d2f
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
115 lines
8.4 KiB
HTML
115 lines
8.4 KiB
HTML
<a name="evs_04_2094"></a><a name="evs_04_2094"></a>
|
|
|
|
<h1 class="topictitle1">Deleting an EVS Snapshot</h1>
|
|
<div id="body1489026315011"><div class="section" id="evs_04_2094__section4805694511340"><h4 class="sectiontitle">Function</h4><p id="evs_04_2094__p29847411340">This API is used to delete an EVS snapshot.</p>
|
|
</div>
|
|
<div class="section" id="evs_04_2094__section18631564103149"><h4 class="sectiontitle">Constraints</h4><ul id="evs_04_2094__ul34741833103418"><li id="evs_04_2094__li11474933113414">A snapshot can be deleted only when it is in the <strong id="evs_04_2094__b191351948195211">available</strong> or <strong id="evs_04_2094__b1915655195218">error</strong> state.</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2094__section268627411340"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2094__ul1626162711340"><li id="evs_04_2094__li1213691911340">URI format<p id="evs_04_2094__p4212340911340"><a name="evs_04_2094__li1213691911340"></a><a name="li1213691911340"></a>DELETE /v2/{project_id}/snapshots/{snapshot_id}</p>
|
|
</li><li id="evs_04_2094__li4356636211340">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2094__table5655293911340" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2094__row4718979611340"><th align="left" class="cellrowborder" valign="top" width="28.57%" id="mcps1.3.3.2.2.1.1.4.1.1"><p id="evs_04_2094__p6427715211340">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.3.2.2.1.1.4.1.2"><p id="evs_04_2094__p3906685711340">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.9%" id="mcps1.3.3.2.2.1.1.4.1.3"><p id="evs_04_2094__p1029885411340">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2094__row2890086411340"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2094__p5926863811340">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.3.2.2.1.1.4.1.2 "><p id="evs_04_2094__p3603037711340">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.9%" headers="mcps1.3.3.2.2.1.1.4.1.3 "><p id="evs_04_2094__p3277940011340">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2094__row2657914711340"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2094__p542726811340">snapshot_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.3.2.2.1.1.4.1.2 "><p id="evs_04_2094__p3695552511340">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.9%" headers="mcps1.3.3.2.2.1.1.4.1.3 "><p id="evs_04_2094__p4060754311340">Specifies the snapshot ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2094__section87667311340"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2094__ul11696153417283"><li id="evs_04_2094__li1069673414281">Example request<pre class="screen" id="evs_04_2094__screen1617184622810">DELETE https://{endpoint}/v2/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2094__section5147449911340"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2094__ul2889143711911"><li id="evs_04_2094__li15611911911">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2094__table46654279102454" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2094__row6664264102454"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="evs_04_2094__p2934472102454">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="evs_04_2094__p1338569102927">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="evs_04_2094__p23036595102454">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2094__row12419334102454"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2094__p129522216412">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2094__evs_04_2010_p1595262111415">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2094__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_2094__li0419202382514">Parameters in the error field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2094__li0419202382514"><a name="evs_04_2094__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2094__evs_04_2013_b1288034833610">error</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2094__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2094__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.2.2.1.4.1.1"><p id="evs_04_2094__evs_04_2013_p19541716103019">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.2.2.1.4.1.2"><p id="evs_04_2094__evs_04_2013_p39375186103019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.5.2.2.2.1.4.1.3"><p id="evs_04_2094__evs_04_2013_p38578950103019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2094__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2094__evs_04_2013_p46815658103019">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2094__evs_04_2013_p33971979103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2094__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2094__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2094__evs_04_2013_p59870541103019">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2094__evs_04_2013_p17675690103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2094__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
|
<p id="evs_04_2094__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_2094__li2903350411916">Example response<p id="evs_04_2094__p57112307111233"><a name="evs_04_2094__li2903350411916"></a><a name="li2903350411916"></a>None</p>
|
|
<p id="evs_04_2094__p52821068113531">or</p>
|
|
<pre class="screen" id="evs_04_2094__screen44315624152655">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_2094__p5655715720175">In the preceding example, <strong id="evs_04_2094__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2094__b842352706144438">badRequest</strong> or <strong id="evs_04_2094__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
|
<pre class="screen" id="evs_04_2094__screen18981229152712">{
|
|
"itemNotFound": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2094__section1751558211340"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2094__ul947606911340"><li id="evs_04_2094__li1817575711340">Normal<p id="evs_04_2094__p2936408711340"><a name="evs_04_2094__li1817575711340"></a><a name="li1817575711340"></a>202</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2094__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2094__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_2092.html">EVS Snapshot</a></div>
|
|
</div>
|
|
</div>
|
|
|