forked from docs/doc-exports
wangdengke2
1ddaec1a62
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>
180 lines
16 KiB
HTML
180 lines
16 KiB
HTML
<a name="rds_09_0018"></a><a name="rds_09_0018"></a>
|
|
|
|
<h1 class="topictitle1">Deleting Manual Backups in Batches (RDS for SQL Server)</h1>
|
|
<div id="body0000002474159980"><div class="section" id="rds_09_0018__section117711820496"><h4 class="sectiontitle">Function</h4><p id="rds_09_0018__en-us_topic_0000002263777974_p179281915182818">This API is used to delete manual backups in batches.</p>
|
|
<ul id="rds_09_0018__ul12259155218373"><li id="rds_09_0018__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_09_0018__en-us_topic_0240111818_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0018__en-us_topic_0000002263777974_section37151215182818"><h4 class="sectiontitle">Constraints</h4><p id="rds_09_0018__en-us_topic_0000002263777974_p592821515289">This API is only available for RDS for SQL Server instances.</p>
|
|
</div>
|
|
<div class="section" id="rds_09_0018__section12081471012"><h4 class="sectiontitle">URI</h4><ul id="rds_09_0018__ul13194498"><li id="rds_09_0018__li615041019120">URI format<p id="rds_09_0018__p615031011219"><a name="rds_09_0018__li615041019120"></a><a name="li615041019120"></a>POST https://{<em id="rds_09_0018__i18815173419160">Endpoint</em>}/v3/{project_id}/backups/batch-delete</p>
|
|
</li><li id="rds_09_0018__li22221662">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0018__table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI Parameters</caption><thead align="left"><tr id="rds_09_0018__row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="rds_09_0018__p10809459"><strong id="rds_09_0018__b1364494214345">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="rds_09_0018__p3150961"><strong id="rds_09_0018__b46451842123418">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="rds_09_0018__p53901255"><strong id="rds_09_0018__b1964574211342">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0018__row3925534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0018__p49532829">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0018__p52736237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0018__p43776822">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_09_0018__p14969328081">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0018__section420839121019"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0018__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_09_0018__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.2.5.1.1"><p id="rds_09_0018__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.4.2.2.5.1.2"><p id="rds_09_0018__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.4.2.2.5.1.3"><p id="rds_09_0018__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.4.2.2.5.1.4"><p id="rds_09_0018__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0018__row353717218338"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_09_0018__p18511533163317">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rds_09_0018__p13511153333312">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_09_0018__p55111833183319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_09_0018__p35111331332">The content type.</p>
|
|
<p id="rds_09_0018__p1351133311330">The default value is <strong id="rds_09_0018__b105111133143310">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0018__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_09_0018__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rds_09_0018__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_09_0018__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_09_0018__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_09_0018__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0018__en-us_topic_0000002263777974_table167341815112814" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="rds_09_0018__en-us_topic_0000002263777974_row1929151502813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="rds_09_0018__en-us_topic_0000002263777974_p692981592810"><strong id="rds_09_0018__b69085914346">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="rds_09_0018__en-us_topic_0000002263777974_p1929161592814"><strong id="rds_09_0018__b14898548193310">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="rds_09_0018__en-us_topic_0000002263777974_p39291015192813"><strong id="rds_09_0018__b43387473512">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="rds_09_0018__en-us_topic_0000002263777974_p109293157284"><strong id="rds_09_0018__b34046617352">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0018__en-us_topic_0000002263777974_row1392912151288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rds_09_0018__en-us_topic_0000002263777974_p792901512815">backup_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rds_09_0018__en-us_topic_0000002263777974_p139290158289">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rds_09_0018__en-us_topic_0000002263777974_p1492931502812">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rds_09_0018__en-us_topic_0000002263777974_p19097451208">IDs of the manual backups to be deleted.</p>
|
|
<p id="rds_09_0018__p1075516183917">Value range: [1, 50]</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rds_09_0018__en-us_topic_0000002263777974_section1040216219817"><h4 class="sectiontitle">Example Request</h4><p id="rds_09_0018__en-us_topic_0000002263777974_p4298061488">Delete manual backups in batches.</p>
|
|
<pre class="screen" id="rds_09_0018__en-us_topic_0000002263777974_screen184579331985">POST https://rds.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/backups/batch-delete
|
|
|
|
{
|
|
"backup_ids" : [ "53ad33abe43976054br04", "63ad3439af9776054br04" ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rds_09_0018__section1229512143106"><h4 class="sectiontitle">Response</h4><ul id="rds_09_0018__ul12573920"><li id="rds_09_0018__li46056421">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0018__table11854613" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="rds_09_0018__row48728718"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="rds_09_0018__p54712068"><strong id="rds_09_0018__b695252672114">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="rds_09_0018__p2492560"><strong id="rds_09_0018__b39521326162111">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="rds_09_0018__p570775"><strong id="rds_09_0018__b1195232682112">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0018__row46232835"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="rds_09_0018__en-us_topic_0000002263777974_p892941592810">delete_results</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="rds_09_0018__en-us_topic_0000002263777974_p593013157285">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="rds_09_0018__p16241338134314">Backup deletion results. For details, see <a href="#rds_09_0018__en-us_topic_0000002263777974_table1274521515288">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_09_0018__en-us_topic_0000002263777974_table1274521515288"></a><a name="en-us_topic_0000002263777974_table1274521515288"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0018__en-us_topic_0000002263777974_table1274521515288" frame="border" border="1" rules="all"><caption><b>Table 5 </b>delete_results field data structure description</caption><thead align="left"><tr id="rds_09_0018__en-us_topic_0000002263777974_row1593071552813"><th align="left" class="cellrowborder" valign="top" width="22.720000000000002%" id="mcps1.3.6.2.1.2.2.4.1.1"><p id="rds_09_0018__en-us_topic_0000002263777974_p1930131510285"><strong id="rds_09_0018__b381965923414">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.85%" id="mcps1.3.6.2.1.2.2.4.1.2"><p id="rds_09_0018__en-us_topic_0000002263777974_p8930141511283"><strong id="rds_09_0018__b151284673515">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.43%" id="mcps1.3.6.2.1.2.2.4.1.3"><p id="rds_09_0018__en-us_topic_0000002263777974_p1930101552812"><strong id="rds_09_0018__b1724611713352">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0018__en-us_topic_0000002263777974_row10930415182814"><td class="cellrowborder" valign="top" width="22.720000000000002%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="rds_09_0018__en-us_topic_0000002263777974_p1293019154287">backup_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.85%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="rds_09_0018__en-us_topic_0000002263777974_p2930181517288">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.43%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="rds_09_0018__en-us_topic_0000002263777974_p24813282213">Backup ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0018__en-us_topic_0000002263777974_row119305151289"><td class="cellrowborder" valign="top" width="22.720000000000002%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="rds_09_0018__en-us_topic_0000002263777974_p179301158285">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.85%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="rds_09_0018__en-us_topic_0000002263777974_p1930161542814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.43%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="rds_09_0018__en-us_topic_0000002263777974_p16930121542813">Code returned after a task is submitted.</p>
|
|
<ul id="rds_09_0018__en-us_topic_0000002263777974_ul12756141116613"><li id="rds_09_0018__en-us_topic_0000002263777974_li17756201110617">If the task is executed successfully, <strong id="rds_09_0018__b1059711384019">0</strong> is returned.</li><li id="rds_09_0018__en-us_topic_0000002263777974_li1875613111469">If the task fails to be executed, the specific error code is returned.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0018__en-us_topic_0000002263777974_row0930101502817"><td class="cellrowborder" valign="top" width="22.720000000000002%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="rds_09_0018__en-us_topic_0000002263777974_p109301715102814">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.85%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="rds_09_0018__en-us_topic_0000002263777974_p4930171514287">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.43%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="rds_09_0018__en-us_topic_0000002263777974_p1593011582810">Description returned after a task is submitted.</p>
|
|
<ul id="rds_09_0018__en-us_topic_0000002263777974_ul139080432066"><li id="rds_09_0018__en-us_topic_0000002263777974_li2090814434615">If the task is executed successfully, <strong id="rds_09_0018__b1578531112417">Success</strong> is returned.</li><li id="rds_09_0018__en-us_topic_0000002263777974_li39086436619">If the task fails to be executed, the specific error information is returned.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_09_0018__ul12806205035420"><li id="rds_09_0018__en-us_topic_0000002263777974_li1586126060">Example response<pre class="screen" id="rds_09_0018__en-us_topic_0000002263777974_screen1795215157718">{
|
|
"delete_results" : [ {
|
|
"backup_id" : "dsfae23fsfdsae3435br04",
|
|
"error_code" : "DBS.200054",
|
|
"error_msg" : "the backup is in use"
|
|
} ,
|
|
{
|
|
"backup_id" : "ed23545223fsfdsae3435br04",
|
|
"error_code" : "0",
|
|
"error_msg" : "Success"
|
|
}
|
|
] }</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0018__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_09_0018__en-us_topic_0032347778_ul7858132212142"><li id="rds_09_0018__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_09_0018__en-us_topic_0032347778_p1040982941020"><a name="rds_09_0018__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_09_0018__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_09_0018__en-us_topic_0032347778_p0723374409"><a name="rds_09_0018__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0018__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_09_0018__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0032347777.html">Backup and Restoration</a></div>
|
|
</div>
|
|
</div>
|
|
|