forked from docs/doc-exports
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
143 lines
12 KiB
HTML
143 lines
12 KiB
HTML
<a name="en-us_topic_0032347781"></a><a name="en-us_topic_0032347781"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a DB Instance</h1>
|
|
<div id="body33650236"><div class="section" id="en-us_topic_0032347781__section29874939"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0032347781__p41314614">This API is used to delete a DB instance.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032347781__section439002"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0032347781__ul58149428"><li id="en-us_topic_0032347781__li53582808">URI format<p id="en-us_topic_0032347781__p12483231"><a name="en-us_topic_0032347781__li53582808"></a><a name="li53582808"></a>PATH: /rds/v1/{project_id}/instances/{instanceId}</p>
|
|
<p id="en-us_topic_0032347781__p54129194154446">Method: DELETE</p>
|
|
</li><li id="en-us_topic_0032347781__li45240216">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347781__table4508766" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032347781__row21306406"><th align="left" class="cellrowborder" valign="top" width="22.05%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0032347781__p48097351"><strong id="en-us_topic_0032347781__b842352706102328_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.07%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0032347781__p3571397"><strong id="en-us_topic_0032347781__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.88%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0032347781__p20847751"><strong id="en-us_topic_0032347781__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0032347781__row10946294"><td class="cellrowborder" valign="top" width="22.05%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0032347781__p14234617">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0032347781__p12153337">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.88%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0032347781__p19338596163746">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0032347781__row1412808"><td class="cellrowborder" valign="top" width="22.05%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0032347781__p47328638">instanceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0032347781__p8414476">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.88%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0032347781__p7417132564016">Specifies the primary node ID of the DB instance.</p>
|
|
<div class="note" id="en-us_topic_0032347781__note18250133224019"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0032347781__p142501332164011">This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0032347781__ul43897299"><li id="en-us_topic_0032347781__li59531373">Restrictions<p id="en-us_topic_0032347781__p5157164710251"><a name="en-us_topic_0032347781__li59531373"></a><a name="li59531373"></a>Standby DB instances cannot be deleted.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032347781__section3951024"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0032347781__ul33748040173952"><li id="en-us_topic_0032347781__li34503532173952">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347781__table2131788218919" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032347781__row4584518218919"><th align="left" class="cellrowborder" valign="top" width="24.242424242424242%" id="mcps1.3.3.2.1.1.2.4.1.1"><p id="en-us_topic_0032347781__p2247228518919"><strong id="en-us_topic_0032347781__b842352706102328_3">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.74427442744275%" id="mcps1.3.3.2.1.1.2.4.1.2"><p id="en-us_topic_0032347781__p831579218919"><strong id="en-us_topic_0032347781__b842352706102346_5">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.01330133013302%" id="mcps1.3.3.2.1.1.2.4.1.3"><p id="en-us_topic_0032347781__p249056018919"><strong id="en-us_topic_0032347781__b842352706163417_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0032347781__row40878818919"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.3.2.1.1.2.4.1.1 "><p id="en-us_topic_0032347781__p3311186118919">keepLastManualBackup</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.74427442744275%" headers="mcps1.3.3.2.1.1.2.4.1.2 "><p id="en-us_topic_0032347781__p6481505018919">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.01330133013302%" headers="mcps1.3.3.2.1.1.2.4.1.3 "><p id="en-us_topic_0032347781__p22237723165518">This parameter is obsolete. Its value can be left empty or set to an integer and has no impact on calling the API.</p>
|
|
<p id="en-us_topic_0032347781__p30519341165019">All automated backups will be deleted and all manual backups will be retained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0032347781__li24703177173959">Request example<pre class="codeblock" id="en-us_topic_0032347781__codeblock4520961181049">{
|
|
"keepLastManualBackup": "0"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032347781__section35559222"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0032347781__ul12573920"><li id="en-us_topic_0032347781__li46056421">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347781__table29807226151454" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032347781__row3223123151454"><th align="left" class="cellrowborder" valign="top" width="24.122412241224122%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0032347781__p59746450151454"><strong id="en-us_topic_0032347781__b842352706102328_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.544254425442546%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0032347781__p7624314151454"><strong id="en-us_topic_0032347781__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0032347781__p13589682151454"><strong id="en-us_topic_0032347781__b842352706163417_7">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0032347781__row27022434151454"><td class="cellrowborder" valign="top" width="24.122412241224122%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0032347781__p41333555151454">extendparam</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.544254425442546%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0032347781__p59683660151454">Dictionary data structure. For details, see <a href="#en-us_topic_0032347781__table32267243">Table 4</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0032347781__p22844941151454">Indicates the returned <strong id="en-us_topic_0032347781__b842352706113519">extendparam</strong> key-value pair.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0032347781__table32267243"></a><a name="table32267243"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347781__table32267243" frame="border" border="1" rules="all"><caption><b>Table 4 </b>extendparam field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347781__row9230088"><th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0032347781__p11190634151741"><strong id="en-us_topic_0032347781__b84235270691445_3">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.16%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0032347781__p16816714151741"><strong id="en-us_topic_0032347781__b842352706164541_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.15%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0032347781__p22858126151741"><strong id="en-us_topic_0032347781__b842352706163417_9">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0032347781__row15736877"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347781__p25628649151741">jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.16%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347781__p1615789151741">List data structure. For details, see <a href="#en-us_topic_0032347781__table57556452151811">Table 5</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.15%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347781__p41083402151741">Indicates the returned <strong id="en-us_topic_0032347781__b842352706113940">jobs</strong> parameter information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0032347781__table57556452151811"></a><a name="table57556452151811"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347781__table57556452151811" frame="border" border="1" rules="all"><caption><b>Table 5 </b>jobs field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347781__row53658718151811"><th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="en-us_topic_0032347781__p36464991151811"><strong id="en-us_topic_0032347781__b84235270691445_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.980000000000004%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="en-us_topic_0032347781__p41158197151811"><strong id="en-us_topic_0032347781__b842352706164541_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="en-us_topic_0032347781__p31836063151811"><strong id="en-us_topic_0032347781__b842352706163417_11">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0032347781__row2444491151811"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0032347781__p3112662151811">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0032347781__p10765391151811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0032347781__p29880500151811">Indicates the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0032347781__ul16665627"><li id="en-us_topic_0032347781__li15772917">Response example<pre class="codeblock" id="en-us_topic_0032347781__codeblock5367796021390">{
|
|
"extendparam": {
|
|
"jobs": [
|
|
{
|
|
"id":"ff8080815a88d52c015a8a0db2250003"
|
|
}
|
|
]
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032347781__section51597550"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0032347781__p28475059">For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_06_0016.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|