forked from docs/doc-exports
Chen, Junjie
a03981f7be
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
106 lines
9.2 KiB
HTML
106 lines
9.2 KiB
HTML
<a name="dcs-api-0312024"></a><a name="dcs-api-0312024"></a>
|
|
|
|
<h1 class="topictitle1">Deleting Backup Files</h1>
|
|
<div id="body1503544695608"><div class="section" id="dcs-api-0312024__en-us_topic_0166889627_section10680121316113"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="dcs-api-0312024__en-us_topic_0166889627_p45631679">This API is used to delete the files backed up by a DCS instance.</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312024__en-us_topic_0166889627_section2310177194512"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312024__en-us_topic_0166889627_p2198111619239">DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}</p>
|
|
<div class="p" id="dcs-api-0312024__en-us_topic_0166889627_p13578121810355"><a href="#dcs-api-0312024__en-us_topic_0166889627_table4154121820350">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312024__en-us_topic_0166889627_table4154121820350"></a><a name="en-us_topic_0166889627_table4154121820350"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312024__en-us_topic_0166889627_table4154121820350" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312024__en-us_topic_0166889627_row17153191817358"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312024__en-us_topic_0166889627_p993885712414">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312024__en-us_topic_0166889627_p215314189354">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312024__en-us_topic_0166889627_p1715320185352">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312024__en-us_topic_0166889627_p215351873519">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312024__en-us_topic_0166889627_row61531718163510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312024__en-us_topic_0166889627_p51531218183514">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312024__en-us_topic_0166889627_p115311813514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312024__en-us_topic_0166889627_p815391853510">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312024__en-us_topic_0166889627_p1153818143518">Project ID. For details on how to obtain the value of this parameter, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312024__en-us_topic_0166889627_row111541118183517"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312024__en-us_topic_0166889627_p161532018113520">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312024__en-us_topic_0166889627_p015314181351">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312024__en-us_topic_0166889627_p11153318123518">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312024__en-us_topic_0166889627_p41533186358">DCS instance ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312024__en-us_topic_0166889627_row18629154113017"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312024__en-us_topic_0166889627_p169201512193020">backup_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312024__en-us_topic_0166889627_p1792101211307">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312024__en-us_topic_0166889627_p1692111233017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312024__en-us_topic_0166889627_p17921191213303">ID of the backup record</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312024__en-us_topic_0166889627_section41195764519"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312024__en-us_topic_0166889627_p19453115101510"><strong id="dcs-api-0312024__en-us_topic_0166889627_b590917488164">Request parameters</strong></p>
|
|
<p id="dcs-api-0312024__en-us_topic_0166889627_p6453215161513">None</p>
|
|
<p id="dcs-api-0312024__en-us_topic_0166889627_p6453215191514"><strong id="dcs-api-0312024__en-us_topic_0166889627_b112885181617">Example request</strong></p>
|
|
<p id="dcs-api-0312024__en-us_topic_0166889627_p144910319314">Request URL:</p>
|
|
<pre class="screen" id="dcs-api-0312024__en-us_topic_0166889627_screen695011894115">DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}</pre>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312024__en-us_topic_0166889627_section11426254461"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312024__en-us_topic_0166889627_p377012105239"><strong id="dcs-api-0312024__en-us_topic_0166889627_b1396185621616">Response parameters</strong></p>
|
|
<p id="dcs-api-0312024__en-us_topic_0166889627_p121721231441"><a href="#dcs-api-0312024__en-us_topic_0166889627_table5929344419">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312024__en-us_topic_0166889627_table5929344419"></a><a name="en-us_topic_0166889627_table5929344419"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312024__en-us_topic_0166889627_table5929344419" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312024__en-us_topic_0166889627_row1173730448"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="dcs-api-0312024__en-us_topic_0166889627_p16173193104416">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.4.4.2.4.1.2"><p id="dcs-api-0312024__en-us_topic_0166889627_p1317316354420">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63%" id="mcps1.3.4.4.2.4.1.3"><p id="dcs-api-0312024__en-us_topic_0166889627_p111730318446">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312024__en-us_topic_0166889627_row1317316317449"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312024__en-us_topic_0166889627_p9174103184416">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312024__en-us_topic_0166889627_p14174113184416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312024__en-us_topic_0166889627_p81742364412">Result of deleting the backup file</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p class="msonormal" id="dcs-api-0312024__en-us_topic_0166889627_p1830212192316"><strong id="dcs-api-0312024__en-us_topic_0166889627_b10892753320">Example response</strong></p>
|
|
<pre class="screen" id="dcs-api-0312024__en-us_topic_0166889627_screen880817510716">{
|
|
"message": ""
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312024__en-us_topic_0166889627_section5301161961211"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312024__en-us_topic_0166889627_p3301319121217"><a href="#dcs-api-0312024__en-us_topic_0166889627_table8301101911215">Table 3</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312024__en-us_topic_0166889627_table8301101911215"></a><a name="en-us_topic_0166889627_table8301101911215"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312024__en-us_topic_0166889627_table8301101911215" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312024__en-us_topic_0166889627_row11302101915124"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312024__en-us_topic_0166889627_p73021519101210">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312024__en-us_topic_0166889627_p830281981219">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312024__en-us_topic_0166889627_row16302121941211"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312024__en-us_topic_0166889627_p63027192128">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312024__en-us_topic_0166889627_p1302171916124">Backup file deleted successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0514005.html">Backup and Restoration APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|