yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/taurusdb/api-ref/gaussdb_11_0007.html
wangdengke2 ee9f8aa0b6 taurusdb_api 
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>
2025-10-30 15:48:33 +00:00

174 lines
14 KiB
HTML
Raw Blame History

<a name="gaussdb_11_0007"></a><a name="gaussdb_11_0007"></a>
<h1 class="topictitle1">Deleting a DB Instance</h1>
<div id="body8662426"><div class="section" id="gaussdb_11_0007__en-us_topic_0000001297664637_section4284989"><h4 class="sectiontitle">Function</h4><p id="gaussdb_11_0007__en-us_topic_0000001297664637_p0506143014918">This API is used to delete a DB instance. Before calling this API:</p>
<ul id="gaussdb_11_0007__en-us_topic_0000001297664637_ul924420236520"><li id="gaussdb_11_0007__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0007__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="gaussdb_11_0007__en-us_topic_0000001297664637_section38564907"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0007__en-us_topic_0000001297664637_ul13194498"><li id="gaussdb_11_0007__en-us_topic_0000001297664637_li51641620">URI format<p id="gaussdb_11_0007__en-us_topic_0000001297664637_p819462816594"><a name="gaussdb_11_0007__en-us_topic_0000001297664637_li51641620"></a><a name="en-us_topic_0000001297664637_li51641620"></a>DELETE https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}</p>
</li><li id="gaussdb_11_0007__en-us_topic_0000001297664637_li4411135064210">URI example<p id="gaussdb_11_0007__p1136115117314"><a name="gaussdb_11_0007__en-us_topic_0000001297664637_li4411135064210"></a><a name="en-us_topic_0000001297664637_li4411135064210"></a>DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01</p>
</li><li id="gaussdb_11_0007__en-us_topic_0000001297664637_li22221662">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0007__en-us_topic_0000001297664637_table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0007__en-us_topic_0000001297664637_row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="gaussdb_11_0007__en-us_topic_0000001297664637_p10809459"><strong id="gaussdb_11_0007__en-us_topic_0000001297664637_b1145921914594">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="gaussdb_11_0007__en-us_topic_0000001297664637_p3150961">Mandatory</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="gaussdb_11_0007__en-us_topic_0000001297664637_p53901255"><strong id="gaussdb_11_0007__en-us_topic_0000001297664637_b116872118595">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0007__en-us_topic_0000001297664637_row3925534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="gaussdb_11_0007__en-us_topic_0000001297664637_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="gaussdb_11_0007__en-us_topic_0000001297664637_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="gaussdb_11_0007__en-us_topic_0000001297664637_p43776822">Project ID of a tenant in a region.</p>
<p id="gaussdb_11_0007__en-us_topic_0000001297664637_p178064411566">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="gaussdb_11_0007__en-us_topic_0000001297664637_row19402550154517"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="gaussdb_11_0007__en-us_topic_0000001297664637_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="gaussdb_11_0007__en-us_topic_0000001297664637_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="gaussdb_11_0007__en-us_topic_0000001297664637_p18462124174611">Instance ID, which is compliant with the UUID format.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="gaussdb_11_0007__section1255118431542"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0007__en-us_topic_0000001226362379_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="gaussdb_11_0007__row155118431416"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="gaussdb_11_0007__p13552943747">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="gaussdb_11_0007__p20552743745">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="gaussdb_11_0007__p13552184319418">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="gaussdb_11_0007__p1755210431046">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0007__row75511043341"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0007__p65521043542">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0007__p555212439414">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0007__p1955219431647">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0007__p17552114319413">User token.</p>
</td>
</tr>
<tr id="gaussdb_11_0007__row1355113431344"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0007__p1855213431244">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0007__p115531443943">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0007__p255354316420">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0007__p55532434412">Language.</p>
</td>
</tr>
<tr id="gaussdb_11_0007__row2045114715453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0007__p15665114311157">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0007__p36651643101518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0007__p10665443181514">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0007__p1866504318159">MIME type of the request body. You are advised to use the default value <strong id="gaussdb_11_0007__b162532775373547">application/json</strong>. For APIs used to upload objects or images, the value can vary depending on the flow type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_11_0007__section1455319431345"><h4 class="sectiontitle">Response Parameters</h4><p id="gaussdb_11_0007__p105531943746"><strong id="gaussdb_11_0007__b155538435411">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0007__en-us_topic_0000001226362379_response_MysqlJobId" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0007__row9553643149"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="gaussdb_11_0007__p455314431146">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="gaussdb_11_0007__p3554184314410">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="gaussdb_11_0007__p17554943247">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0007__row1255364313420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_11_0007__p1355474311414">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_11_0007__p1554134312418">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_11_0007__p16655115865012">ID of the task for deleting a DB instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_11_0007__p185542431247"><strong id="gaussdb_11_0007__b61666654772457">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0007__en-us_topic_0000001226362379_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0007__row45549431948"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="gaussdb_11_0007__p7555114317419">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="gaussdb_11_0007__p165553431442">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="gaussdb_11_0007__p1055513438412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0007__row1855424315413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0007__p05558432044">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0007__p10555943442">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0007__p755517432414">Error code.</p>
</td>
</tr>
<tr id="gaussdb_11_0007__row655412432041"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0007__p555517431045">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0007__p12555243642">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0007__p125561843642">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_11_0007__p1855613431420"><strong id="gaussdb_11_0007__b12275112846404">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0007__table255694317415" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0007__row105563431340"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="gaussdb_11_0007__p10556114313417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="gaussdb_11_0007__p45569436415">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="gaussdb_11_0007__p1255614431846">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0007__row4556943946"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_11_0007__p115562431748">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_11_0007__p165561443546">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0007__p655714431242">Error code.</p>
</td>
</tr>
<tr id="gaussdb_11_0007__row125562043946"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_11_0007__p25571443548">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_11_0007__p95571432415">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0007__p5557943243">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_11_0007__section153471536141116"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="gaussdb_11_0007__screen16381723125317">DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/3d39c18788b54a919bab633874c159dfin01</pre>
</div>
<div class="section" id="gaussdb_11_0007__section955711431649"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_11_0007__p95578438415"><strong id="gaussdb_11_0007__b12255796416404">Status code: 500</strong></p>
<p id="gaussdb_11_0007__p1155734315415">Server error.</p>
<pre class="screen" id="gaussdb_11_0007__screen125573431544">{
"job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}</pre>
</div>
<div class="section" id="gaussdb_11_0007__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_11_0007__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="gaussdb_11_0007__section2557116171718"><h4 class="sectiontitle">Error Code</h4><p id="gaussdb_11_0007__p855716160178">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_11_0003.html">Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink