vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/csbs/api-ref/en-us_topic_0059304232.html
Wei, Hongmin 8ce662c4dc CSBS API initial version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-24 21:06:50 +00:00

156 lines
12 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0059304232"></a><a name="EN-US_TOPIC_0059304232"></a>
<h1 class="topictitle1">Deleting a Backup</h1>
<div id="body27629589"><div class="section" id="EN-US_TOPIC_0059304232__section24937164"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="EN-US_TOPIC_0059304232__p23404226">This API is used to delete a backup.</p>
<div class="note" id="EN-US_TOPIC_0059304232__note177452421741"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0059304232__p167464421240">The deletion operation is asynchronous. Tasks will be queued depending on the background task execution status. Therefore, the deletion will not be completed immediately. You need to query the task information continuously to obtain the deletion result. A maximum of 30 minutes is required.</p>
<p id="EN-US_TOPIC_0059304232__p2962165915714">For example, a user can execute a maximum of five backup deletion tasks concurrently. If the number exceeds five, the sixth and subsequent tasks are queued.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0059304232__section23107889"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0059304232__ul16694135"><li id="EN-US_TOPIC_0059304232__li16029493">URI format<p id="EN-US_TOPIC_0059304232__p10047709"><a name="EN-US_TOPIC_0059304232__li16029493"></a><a name="li16029493"></a>DELETE https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints/{checkpoint_id}</p>
</li><li id="EN-US_TOPIC_0059304232__li23320522">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304232__table8558107" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304232__row46491595"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0059304232__p209623317216">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0059304232__p15962193221">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0059304232__p99783315213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0059304232__p6978835213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304232__row10556491"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304232__p49769413">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304232__p4790635">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304232__p52497191">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304232__p65779720">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304232__row18399828"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304232__p13991122">provider_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304232__p59539072">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304232__p57935494">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304232__p62263437">Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is <strong id="EN-US_TOPIC_0059304232__b20451623192612">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304232__row23500024"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304232__p24453795">checkpoint_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304232__p34600354">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304232__p51165278">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304232__p50746814">Backup record ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304232__section6644414"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0059304232__ul16851242"><li id="EN-US_TOPIC_0059304232__li17443457">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304232__table22773387" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304232__row11530445"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0059304232__p13881956816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0059304232__p178813517810">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0059304232__p178811451187">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0059304232__p4881855818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304232__row21960560"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304232__p33974975">checkpoint_items</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304232__p509623">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304232__p41279487">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304232__p55304127">Indicates the ID list of the backup records to be deleted. If this parameter is not set, all backup records of <strong id="EN-US_TOPIC_0059304232__b59079939">checkpoint</strong> will be deleted.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304232__li27975100">Parameter description<p class="msonormal" id="EN-US_TOPIC_0059304232__p1875419424567"><a name="EN-US_TOPIC_0059304232__li27975100"></a><a name="li27975100"></a>None</p>
</li></ul>
<ul id="EN-US_TOPIC_0059304232__ul51390628"><li id="EN-US_TOPIC_0059304232__li59862473">Example request<pre class="screen" id="EN-US_TOPIC_0059304232__screen185521442102219">Deleting all backups in the specified backup record:
DELETE https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints/{checkpoint_id}
Deleting a single backup in the specified backup record:
DELETE https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints/{checkpoint_id}?checkpoint_items={checkpoint_items_id}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304232__section59799733"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0059304232__ul18981890"><li id="EN-US_TOPIC_0059304232__li36619286">Parameter description<p class="msonormal" id="EN-US_TOPIC_0059304232__p61138120"><a name="EN-US_TOPIC_0059304232__li36619286"></a><a name="li36619286"></a>None</p>
</li></ul>
<ul id="EN-US_TOPIC_0059304232__ul164019261165"><li id="EN-US_TOPIC_0059304232__li11586820">Example response<pre class="screen" id="EN-US_TOPIC_0059304232__screen1379713292010">{
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304232__section1326685"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0059304232__ul23516496"><li id="EN-US_TOPIC_0059304232__li10321876">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304232__table25788020" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304232__row56719680"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.1.3.1.1"><p id="EN-US_TOPIC_0059304232__p30891373">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.1.1.1.3.1.2"><p id="EN-US_TOPIC_0059304232__p19173303">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304232__row9533701"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304232__p34032320">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304232__p5154511">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304232__li46390602">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304232__table14862235" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304232__row17500102"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0059304232__p8222144">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0059304232__p62013947">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304232__row57073823"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304232__p59576914">400</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304232__p61000767">Invalid request parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304232__row12135994"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304232__p43491438">401</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304232__p33145583">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304232__row29874791"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304232__p3939013">403</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304232__p50624676">No operation permission.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304232__row52968908"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304232__p62623118">404</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304232__p39307813">Requested object not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304232__row18226004"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304232__p67020229">500</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304232__p59929470">Service internal error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304232__row2494326"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304232__p713839">503</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304232__p57820997">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304232__section61541938486"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0059304232__p999593594811">For details, see <a href="en-us_topic_0071888297.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0059304229.html">Backup Management</a></div>
</div>
</div>
View Git Blame Copy Permalink