doc-exports/docs/rds/api-ref/rds_01_0003.html
Ru, Li Yi 9457035d64 rds_api
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-07-03 08:42:51 +00:00

80 lines
7.2 KiB
HTML

<a name="rds_01_0003"></a><a name="rds_01_0003"></a>
<h1 class="topictitle1">Deleting a DB Instance</h1>
<div id="body1535613843473"><div class="section" id="rds_01_0003__section4284989"><h4 class="sectiontitle">Function</h4><p id="rds_01_0003__p0506143014918">This API is used to delete a DB instance.</p>
<ul id="rds_01_0003__ul12259155218373"><li id="rds_01_0003__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_01_0003__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_01_0003__section38564907"><h4 class="sectiontitle">URI</h4><ul id="rds_01_0003__ul13194498"><li id="rds_01_0003__li51641620">URI format<p id="rds_01_0003__p819462816594"><a name="rds_01_0003__li51641620"></a><a name="li51641620"></a>DELETE https://{<em id="rds_01_0003__i18573165316156">Endpoint</em>}/v3/{project_id}/instances/{instance_id}</p>
</li><li id="rds_01_0003__li22221662">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0003__table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_01_0003__row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="rds_01_0003__p10809459"><strong id="rds_01_0003__b9296112613193">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="rds_01_0003__p3150961"><strong id="rds_01_0003__b0858729171912">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="rds_01_0003__p53901255"><strong id="rds_01_0003__b14869123081916">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_01_0003__row3925534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_01_0003__p49532829">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_01_0003__p52736237">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_01_0003__p43776822">Specifies the project ID of a tenant in a region.</p>
<p id="rds_01_0003__p178064411566">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="rds_01_0003__row19402550154517"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_01_0003__p1046217474614">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_01_0003__p246284104619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_01_0003__p18462124174611">Specifies the DB instance ID compliant with the UUID format.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="rds_01_0003__section1390010340492"><h4 class="sectiontitle">Request</h4><ul id="rds_01_0003__ul1183180183717"><li id="rds_01_0003__li1283110163719">Request parameters<p id="rds_01_0003__p848415163614"><a name="rds_01_0003__li1283110163719"></a><a name="li1283110163719"></a>None</p>
</li></ul>
<ul id="rds_01_0003__ul2447114683012"><li id="rds_01_0003__li4411135064210">Example<p id="rds_01_0003__p1454414211213"><a name="rds_01_0003__li4411135064210"></a><a name="li4411135064210"></a>DELETE https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01</p>
</li></ul>
</div>
<div class="section" id="rds_01_0003__section36749739"><h4 class="sectiontitle">Response</h4><ul id="rds_01_0003__ul48268995"><li id="rds_01_0003__li31767774">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0003__table17474517" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_01_0003__row16146366"><th align="left" class="cellrowborder" valign="top" width="26.38%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_01_0003__p32787233"><strong id="rds_01_0003__b1095164516326">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.29%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_01_0003__p38520254"><strong id="rds_01_0003__b231334618324">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_01_0003__p33132859"><strong id="rds_01_0003__b11276447183217">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_01_0003__row1625804435012"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_01_0003__p1165525810503">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="40.29%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_01_0003__p116551958135013">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_01_0003__p16655115865012">Indicates the ID of the instance deletion task.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="rds_01_0003__li966441310127">Example normal response<pre class="codeblock" id="rds_01_0003__codeblock11412165015361">{
"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}</pre>
</li><li id="rds_01_0003__li18559781316">Abnormal response<p id="rds_01_0003__p172314336131"><a name="rds_01_0003__li18559781316"></a><a name="li18559781316"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
</li></ul>
</div>
<div class="section" id="rds_01_0003__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_01_0003__rds_01_0002_en-us_topic_0032347778_ul7858132212142"><li id="rds_01_0003__rds_01_0002_en-us_topic_0032347778_li58581622171411">Normal<p id="rds_01_0003__rds_01_0002_en-us_topic_0032347778_p1040982941020"><a name="rds_01_0003__rds_01_0002_en-us_topic_0032347778_li58581622171411"></a><a name="rds_01_0002_en-us_topic_0032347778_li58581622171411"></a>202</p>
</li><li id="rds_01_0003__rds_01_0002_en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_01_0003__rds_01_0002_en-us_topic_0032347778_p0723374409"><a name="rds_01_0003__rds_01_0002_en-us_topic_0032347778_li11583183218149"></a><a name="rds_01_0002_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_01_0003__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_01_0003__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_0056887470.html">DB Instance Management</a></div>
</div>
</div>