vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/gaussdb_mysql/api-ref/DeleteGaussMySqlBackup.html
Wang , Deng Ke 4b019093fa Modified the response parameters and examples in Deleting a Manual Backup. 
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2023-11-07 10:44:23 +00:00

176 lines
13 KiB
HTML
Raw Permalink Blame History

<a name="DeleteGaussMySqlBackup"></a><a name="DeleteGaussMySqlBackup"></a>
<h1 class="topictitle1">Deleting a Manual Backup</h1>
<div id="body8662426"><div class="section" id="DeleteGaussMySqlBackup__section97284287439"><h4 class="sectiontitle">Function</h4><p id="DeleteGaussMySqlBackup__p8730102874314">This API is used to delete a manual backup. Before calling this API:</p>
<ul id="DeleteGaussMySqlBackup__ul924420236520"><li id="DeleteGaussMySqlBackup__gaussdb_04_0001_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="DeleteGaussMySqlBackup__gaussdb_04_0001_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="DeleteGaussMySqlBackup__section7734142834320"><h4 class="sectiontitle">URI</h4><p id="DeleteGaussMySqlBackup__p11736328194313">DELETE /v3/{project_id}/backups/{backup_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlBackup__table1673902814436" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="DeleteGaussMySqlBackup__row873752854316"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteGaussMySqlBackup__p6740162818432">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteGaussMySqlBackup__p11742132820431">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteGaussMySqlBackup__p147430284432">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteGaussMySqlBackup__p07458283436">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteGaussMySqlBackup__row47385285430"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteGaussMySqlBackup__p174642884320">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteGaussMySqlBackup__p1074732834319">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteGaussMySqlBackup__p1774972834318">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteGaussMySqlBackup__p57508286431">Project ID of a tenant in a region.</p>
</td>
</tr>
<tr id="DeleteGaussMySqlBackup__row10738132824315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteGaussMySqlBackup__p177521828134319">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteGaussMySqlBackup__p117531628174310">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteGaussMySqlBackup__p97541028194313">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteGaussMySqlBackup__p15755112844320">Backup file ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteGaussMySqlBackup__section1575692844314"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlBackup__en-us_topic_0000001421288836_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="DeleteGaussMySqlBackup__row15761102815430"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteGaussMySqlBackup__p1876312813439">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteGaussMySqlBackup__p9765328104314">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteGaussMySqlBackup__p14767102894316">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteGaussMySqlBackup__p13769172834318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteGaussMySqlBackup__row177617283438"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteGaussMySqlBackup__p127701428194318">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteGaussMySqlBackup__p17771112864318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteGaussMySqlBackup__p47731284433">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteGaussMySqlBackup__p18774928154310">User token.</p>
</td>
</tr>
<tr id="DeleteGaussMySqlBackup__row57611528154314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteGaussMySqlBackup__p67751728154316">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteGaussMySqlBackup__p1977712818435">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteGaussMySqlBackup__p137781428134312">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteGaussMySqlBackup__p0780328154319">Language.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteGaussMySqlBackup__section13781112894317"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteGaussMySqlBackup__p17783112819433"><strong id="DeleteGaussMySqlBackup__b10783162874311">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlBackup__en-us_topic_0000001421288836_response_MysqlJobId" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameter</caption><thead align="left"><tr id="DeleteGaussMySqlBackup__row87849286434"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteGaussMySqlBackup__p97871128124310">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteGaussMySqlBackup__p1878882874311">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteGaussMySqlBackup__p8790728194312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteGaussMySqlBackup__row19784112894318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteGaussMySqlBackup__p151401812192319">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteGaussMySqlBackup__p914051211237">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteGaussMySqlBackup__p19140141212314">Backup ID.</p>
</td>
</tr>
<tr id="DeleteGaussMySqlBackup__row163907596226"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteGaussMySqlBackup__p1614081202316">backup_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteGaussMySqlBackup__p1714061210231">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteGaussMySqlBackup__p8140121212230">Backup name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteGaussMySqlBackup__p779542813436"><strong id="DeleteGaussMySqlBackup__b1579662815439">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlBackup__en-us_topic_0000001421288836_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameter</caption><thead align="left"><tr id="DeleteGaussMySqlBackup__row7797102884311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="DeleteGaussMySqlBackup__p16799132874318">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="DeleteGaussMySqlBackup__p108005283432">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="DeleteGaussMySqlBackup__p780213282438">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteGaussMySqlBackup__row20797132819436"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="DeleteGaussMySqlBackup__p1480352824310">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="DeleteGaussMySqlBackup__p15807142817433">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="DeleteGaussMySqlBackup__p1080882818437">Error code.</p>
</td>
</tr>
<tr id="DeleteGaussMySqlBackup__row16797202818439"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="DeleteGaussMySqlBackup__p1481042815434">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="DeleteGaussMySqlBackup__p681212819438">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="DeleteGaussMySqlBackup__p881372814313">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteGaussMySqlBackup__p19814828134312"><strong id="DeleteGaussMySqlBackup__b1981510286434">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlBackup__table11815172854317" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameter</caption><thead align="left"><tr id="DeleteGaussMySqlBackup__row98161628184319"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="DeleteGaussMySqlBackup__p1081819286439">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="DeleteGaussMySqlBackup__p1881912813439">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="DeleteGaussMySqlBackup__p108202284439">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteGaussMySqlBackup__row138161328164317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="DeleteGaussMySqlBackup__p3823122874317">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="DeleteGaussMySqlBackup__p13824328164319">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="DeleteGaussMySqlBackup__p9826172874312">Error code.</p>
</td>
</tr>
<tr id="DeleteGaussMySqlBackup__row1581632810436"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="DeleteGaussMySqlBackup__p5827172814312">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="DeleteGaussMySqlBackup__p2082813283433">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="DeleteGaussMySqlBackup__p983017289439">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteGaussMySqlBackup__section6831428124314"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="DeleteGaussMySqlBackup__screen13691124194">DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/backups/1fe4feaab48f11e6654hfa163eba87e4b66</pre>
</div>
<div class="section" id="DeleteGaussMySqlBackup__section13833328194314"><h4 class="sectiontitle">Example Response</h4><p id="DeleteGaussMySqlBackup__p20835142816431"><strong id="DeleteGaussMySqlBackup__b7835142824320">Status code: 200</strong></p>
<p id="DeleteGaussMySqlBackup__p16836152816434">Success.</p>
<pre class="screen" id="DeleteGaussMySqlBackup__screen08386287439">{
"backup_id" : "b1182ccdda034f2b9535f3dca5c47e71br07",
"backup_name" : "backup-f3c1"
}</pre>
</div>
<div class="section" id="DeleteGaussMySqlBackup__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="DeleteGaussMySqlBackup__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="DeleteGaussMySqlBackup__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="DeleteGaussMySqlBackup__p19357163913406">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_06_0002.html">Backup Management</a></div>
</div>
</div>
View Git Blame Copy Permalink