doc-exports/docs/dds/api-ref/dds_api_0022.html
Wang , Deng Ke daee48595f DDS API 20221101 version
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>
2022-11-10 07:51:13 +00:00

75 lines
6.2 KiB
HTML

<a name="dds_api_0022"></a><a name="dds_api_0022"></a>
<h1 class="topictitle1">Deleting a DB Instance</h1>
<div id="body33650236"><div class="section" id="dds_api_0022__section29874939"><h4 class="sectiontitle">Function</h4><p id="dds_api_0022__p41314614">This API is used to delete a DB instance.</p>
</div>
<div class="section" id="dds_api_0022__section439002"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0022__ul58149428"><li id="dds_api_0022__li53582808">URI format<p id="dds_api_0022__p5623154481817"><a name="dds_api_0022__li53582808"></a><a name="li53582808"></a>DELETE /v3/{project_id}/instances/{instance_id}</p>
</li><li id="dds_api_0022__li45240216">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0022__table4508766" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0022__row21306406"><th align="left" class="cellrowborder" valign="top" width="22.05%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_api_0022__p48097351"><strong id="dds_api_0022__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="dds_api_0022__p3571397"><strong id="dds_api_0022__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="dds_api_0022__p2775334615440"><strong id="dds_api_0022__b1211711271793">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0022__row10946294"><td class="cellrowborder" valign="top" width="22.05%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0022__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="dds_api_0022__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="dds_api_0022__p19338596163746">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
<tr id="dds_api_0022__row1412808"><td class="cellrowborder" valign="top" width="22.05%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0022__p47328638">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0022__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="dds_api_0022__p10483995">Specifies the DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0022__section3951024"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0022__ul1945810274247"><li id="dds_api_0022__li7458152782410">Request header<pre class="codeblock" id="dds_api_0022__codeblock1497683019423"><strong id="dds_api_0022__b8340285321">DELETE </strong><strong id="dds_api_0022__b1034158193212"><em id="dds_api_0022__i173403813328">https://</em></strong><strong id="dds_api_0022__b834216818322"><em id="dds_api_0022__i13341682322">DDS endpoint</em></strong><strong id="dds_api_0022__b103421784328">/v3/{</strong><strong id="dds_api_0022__b334417893219"><em id="dds_api_0022__i1634217819328">project_id</em></strong><strong id="dds_api_0022__b1534417814323">}/instances/{</strong><strong id="dds_api_0022__b6345178173214"><em id="dds_api_0022__i434516812323">instance_id</em></strong><strong id="dds_api_0022__b634615810321">}</strong></pre>
</li><li id="dds_api_0022__li83029323246">Request body<p id="dds_api_0022__p615889515440"><a name="dds_api_0022__li83029323246"></a><a name="li83029323246"></a>N/A</p>
</li></ul>
</div>
<div class="section" id="dds_api_0022__section35559222"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0022__ul12573920"><li id="dds_api_0022__li46056421">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0022__table29807226151454" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0022__row3223123151454"><th align="left" class="cellrowborder" valign="top" width="24.122412241224122%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0022__p59746450151454"><strong id="dds_api_0022__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="dds_api_0022__p7624314151454"><strong id="dds_api_0022__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="dds_api_0022__p125849352116"><strong id="dds_api_0022__b83503302093">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0022__row19231203392012"><td class="cellrowborder" valign="top" width="24.122412241224122%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0022__p417012163212">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="42.544254425442546%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0022__p317018169216">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0022__p1017071652111">Indicates the workflow ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="dds_api_0022__ul16665627"><li id="dds_api_0022__li15772917">Response example<pre class="codeblock" id="dds_api_0022__codeblock5367796021390">{
"job_id": "252f11f1-2912-4c06-be55-1999bde659c5"
}</pre>
</li></ul>
</div>
<div class="section" id="dds_api_0022__section5382712154838"><h4 class="sectiontitle"><strong id="dds_api_0022__dds_api_0018_b5215121503">Status Code</strong></h4><p id="dds_api_0022__dds_api_0018_p1351064932715">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
</div>
<div class="section" id="dds_api_0022__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0022__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
</div>
</div>