Files
doc-exports/docs/geminidb/api-ref/DeleteBackup.html
wangdengke2 59805c5073 GeminiDB_API
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2026-03-12 09:56:41 +00:00

108 lines
7.6 KiB
HTML

<a name="DeleteBackup"></a><a name="DeleteBackup"></a>
<h1 class="topictitle1">Deleting a Manual Backup</h1>
<div id="body380013113445"><div class="section" id="DeleteBackup__section1801431154410"><h4 class="sectiontitle">Function</h4><p id="DeleteBackup__p20801143113441">This API is used to delete a manual backup.</p>
</div>
<div class="section" id="DeleteBackup__section28028311445"><h4 class="sectiontitle">Constraints</h4><p id="DeleteBackup__p1880273116447">This API supports the following instances:</p>
<ul id="DeleteBackup__ul1680363111448"><li id="DeleteBackup__li121091030181010"><span id="DeleteBackup__text13109930121018">GeminiDB Cassandra</span></li><li id="DeleteBackup__li411013011016"><span id="DeleteBackup__text6110163016104">GeminiDB Influx</span></li></ul>
</div>
<div class="section" id="DeleteBackup__section19810731144413"><h4 class="sectiontitle">URI</h4><p id="DeleteBackup__p1381113124415">DELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteBackup__table17813731124418" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="DeleteBackup__row11812231114418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="DeleteBackup__p78131531124411">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="DeleteBackup__p118151931174412">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="DeleteBackup__p18816153134412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="DeleteBackup__p1881733115440">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBackup__row158121731164414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="DeleteBackup__p9817193134414">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="DeleteBackup__p19818173194414">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="DeleteBackup__p1819163113442">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="DeleteBackup__p178199312447">Project ID of a user in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="DeleteBackup__row481263110449"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="DeleteBackup__p10820133110443">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="DeleteBackup__p2082116312440">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="DeleteBackup__p1382173118448">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="DeleteBackup__p3822131144417">Backup file ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteBackup__section3822113114412"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteBackup__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="DeleteBackup__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="DeleteBackup__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="DeleteBackup__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="DeleteBackup__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="DeleteBackup__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBackup__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="DeleteBackup__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="DeleteBackup__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="DeleteBackup__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="DeleteBackup__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteBackup__section1383353117446"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteBackup__p168341331104417"><strong id="DeleteBackup__b388110511430">Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteBackup__response_DeleteBackupResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="DeleteBackup__row1683543119445"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="DeleteBackup__p1283616310441">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="DeleteBackup__p148371231104410">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="DeleteBackup__p14838123119447">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBackup__row20835163113448"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="DeleteBackup__p98389316447">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="DeleteBackup__p1983963144412">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="DeleteBackup__p4840143110444">Task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteBackup__section68410312447"><h4 class="sectiontitle">Example Requests</h4><ul id="DeleteBackup__ul584143112441"><li id="DeleteBackup__li1084243117447">URI example<pre class="screen" id="DeleteBackup__screen38427318447">DELETE https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/backups/5b0ae36cb8a746b68685a8fb588d8a15br06</pre>
</li></ul>
</div>
<div class="section" id="DeleteBackup__section17845931194413"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteBackup__p15845531164415"><strong id="DeleteBackup__b25281736443">Status code: 202</strong></p>
<p id="DeleteBackup__p1184619318442">Accepted</p>
<pre class="screen" id="DeleteBackup__screen48491931144419">{
"job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae"
}</pre>
</div>
<div class="section" id="DeleteBackup__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="DeleteBackup__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="DeleteBackup__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteBackup__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Backups and Restorations</a></div>
</div>
</div>