vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/opengauss/api-ref/opengauss_api_1017.html
Ru, Li Yi d97aea4dd2 opengauss_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-09-06 09:04:21 +00:00

78 lines
9.7 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001917290420"></a><a name="EN-US_TOPIC_0000001917290420"></a>
<h1 class="topictitle1">Deleting a DB Instance</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section4284989"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p0506143014918">This API is used to delete a DB instance. Before calling this API:</p>
<ul id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section38564907"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_ul13194498"><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li51641620">URI format<p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p819462816594"><a name="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li51641620"></a><a name="en-us_topic_0128427214_li51641620"></a>DELETE https://{<em id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/opengauss/v3/{project_id}/instances/{instance_id}</p>
</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li4411135064210">Example<p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p1454414211213"><a name="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li4411135064210"></a><a name="en-us_topic_0128427214_li4411135064210"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01</p>
</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li22221662">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p10809459"><strong id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_b9296112613193">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p3150961"><strong id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_b0858729171912">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p53901255"><strong id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_b14869123081916">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_row3925534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p49532829">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p52736237">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p43776822">Project ID of a tenant in a region.</p>
<p id="EN-US_TOPIC_0000001917290420__p8544202712219">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_row19402550154517"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p1046217474614">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p246284104619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p18462124174611">DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section1390010340492"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p2901934154915">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section36749739"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_ul48268995"><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li31767774">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_table17474517" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_row16146366"><th align="left" class="cellrowborder" valign="top" width="26.38%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p32787233"><strong id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p38520254"><strong id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p33132859"><strong id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_b11276447183217">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_row1625804435012"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p16655115865012">ID of the DB instance deletion task.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li966441310127">Example normal response<pre class="codeblock" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_codeblock11412165015361">{
"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}</pre>
</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li18559781316">Abnormal response<p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p172314336131"><a name="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li18559781316"></a><a name="en-us_topic_0128427214_li18559781316"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411"></a>202</p>
</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_1014.html">DB Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink