forked from docs/doc-exports
Wang , Deng Ke
a96a12ecf1
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
76 lines
7.9 KiB
HTML
76 lines
7.9 KiB
HTML
<a name="opengauss_api_0017"></a><a name="opengauss_api_0017"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a DB Instance</h1>
|
|
<div id="body8662426"><div class="section" id="opengauss_api_0017__s427459083be941969f004d90fd301bbd"><h4 class="sectiontitle">Function</h4><p id="opengauss_api_0017__a3753db980fb24879bd0f598a53402896">This API is used to delete a DB instance. </p>
|
|
<ul id="opengauss_api_0017__u21cfd97bde1b4942bbc1b44c318aeef9"><li id="opengauss_api_0017__en-us_topic_0256709922_li41227910453">Before calling an API, you need to understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="opengauss_api_0017__lb5b27d5b1c7e4fb6aa975d2581fcbcf8">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="opengauss_api_0017__s8cdbd7bad1d84a0185b11d6feae45f7f"><h4 class="sectiontitle">URI</h4><ul id="opengauss_api_0017__en-us_topic_0128427214_ul13194498"><li id="opengauss_api_0017__en-us_topic_0128427214_li51641620">URI format<p id="opengauss_api_0017__en-us_topic_0128427214_p819462816594"><a name="opengauss_api_0017__en-us_topic_0128427214_li51641620"></a><a name="en-us_topic_0128427214_li51641620"></a>DELETE https://{<em id="opengauss_api_0017__a1e43346df0ec495a8184551b098f4628">Endpoint</em>}/opengauss/v3/{project_id}/instances/{instance_id}</p>
|
|
</li><li id="opengauss_api_0017__l68043f5f5fb441b3adc220ebc73595ef">Example<p id="opengauss_api_0017__a9c52766ff78d42dba8f11f8a3235bf7d"><a name="opengauss_api_0017__l68043f5f5fb441b3adc220ebc73595ef"></a><a name="l68043f5f5fb441b3adc220ebc73595ef"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01</p>
|
|
</li><li id="opengauss_api_0017__en-us_topic_0128427214_li22221662">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0017__en-us_topic_0128427214_table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0017__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="opengauss_api_0017__en-us_topic_0128427214_p10809459"><strong id="opengauss_api_0017__a3beeb6f3940e4a5abbb40686cf59b7e7">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="opengauss_api_0017__en-us_topic_0128427214_p3150961"><strong id="opengauss_api_0017__a332090b45f024844bb06d9647e155bac">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="opengauss_api_0017__en-us_topic_0128427214_p53901255"><strong id="opengauss_api_0017__aa9c2afc598f54bc4b93b270ba97f68b6">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0017__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="opengauss_api_0017__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="opengauss_api_0017__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="opengauss_api_0017__en-us_topic_0128427214_p43776822">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="opengauss_api_0017__p8544202712219">For details about how to obtain the project ID, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="opengauss_api_0017__rbbbcb3b9c8124cd0ac00d7b1289e6ef0"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="opengauss_api_0017__abe634873bf7340eeb9dde5363fb0ac9e">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="opengauss_api_0017__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="opengauss_api_0017__aa6b0567e50a74aae908a757fb27db946">Specifies the DB instance ID compliant with the UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0017__s5a4a5866b994426280e96be0920ad68f"><h4 class="sectiontitle">Request</h4><p id="opengauss_api_0017__ababdffb384a24889b0527006e37bb68b">None</p>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0017__s5125736d95d84cdea4dc6e30c38fb271"><h4 class="sectiontitle">Response</h4><ul id="opengauss_api_0017__en-us_topic_0128427214_ul48268995"><li id="opengauss_api_0017__en-us_topic_0128427214_li31767774">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0017__en-us_topic_0128427214_table17474517" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0017__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="opengauss_api_0017__en-us_topic_0128427214_p32787233"><strong id="opengauss_api_0017__abe63fbcd3ae94c5d805613f28b13454f">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="opengauss_api_0017__en-us_topic_0128427214_p38520254"><strong id="opengauss_api_0017__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="opengauss_api_0017__en-us_topic_0128427214_p33132859"><strong id="opengauss_api_0017__a28ab7badd9904b98856dfa08b65dda3a">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0017__r8dfd765c2f30460698d01de6b59086b6"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="opengauss_api_0017__a8acc9ba29f3b4b3eb1c096b445e4e48e">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="opengauss_api_0017__a89ccc08444a444b883dd1dc9e208b752">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="opengauss_api_0017__a234aa3df3f2a406eac573678e65174f6">Indicates the ID of the DB instance deletion task.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="opengauss_api_0017__l8bdfe9ace3f54739ad29dd72e270d3c0">Example normal response<pre class="codeblock" id="opengauss_api_0017__caf816eb9c0b04225a0726430c29e1554">{
|
|
"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
|
|
}</pre>
|
|
</li><li id="opengauss_api_0017__en-us_topic_0128427214_li18559781316">Abnormal response<p id="opengauss_api_0017__en-us_topic_0128427214_p172314336131"><a name="opengauss_api_0017__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="opengauss_api_0017__s3284251ebd4541779bde9ebcb7c73759"><h4 class="sectiontitle">Status Codes</h4><p id="opengauss_api_0017__ad6824e04527a4a76a14f3ecaae2eb642">For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0017__s54bd14d25ce64947987555c84bb3a69a"><h4 class="sectiontitle">Error Codes</h4><p id="opengauss_api_0017__a478f17fa76dc42f792612496f9e1fdba">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_0014.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|