forked from docs/doc-exports
Lu, Huayi
24f47208ec
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Lu, Huayi <luhuayi@huawei.com> Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
127 lines
10 KiB
HTML
127 lines
10 KiB
HTML
<a name="EN-US_TOPIC_0000001185991698"></a><a name="EN-US_TOPIC_0000001185991698"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Cluster</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_s7aa3de1b44f14c0487bab690bb5702d6"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_af45ba7dd71a6422c9a39c39b44dbd8a8">This API is used to delete clusters. All resources of the deleted cluster, including customer data, will be released. For data security, create a snapshot for the cluster that you want to delete before deleting the cluster.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_s9db56e76e7694a5cbfd993c7d1db0606"><h4 class="sectiontitle">URI</h4><pre class="screen" id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_screen2075183945717">DELETE /v1.0/{project_id}/clusters/{cluster_id}</pre>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185991698__table1270101631817" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185991698__row1426931671819"><th align="left" class="cellrowborder" valign="top" width="18.3%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001185991698__p6268151610184"><strong id="EN-US_TOPIC_0000001185991698__b13436951768205">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.82%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001185991698__p9268716171812"><strong id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_b6167984116271">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.899999999999999%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001185991698__p02687169183"><strong id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_b12971332142216">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.98%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001185991698__p19269316181813"><strong id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_b472253322216">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001185991698__row1726911161185"><td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001185991698__p14269816121810">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.82%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001185991698__p192692162183">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001185991698__p42691216181815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.98%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001185991698__p126915161187"><span id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_text1652174616308">Project ID</span>. For details about how to obtain the ID, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001185991698__row62701163184"><td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001185991698__p226901610188">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.82%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001185991698__p19270416181811">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001185991698__p1327051611184">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.98%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001185991698__p2027011164188">ID of the cluster to be deleted. For details about how to obtain the ID, see <a href="dws_02_00068.html">Obtaining the Cluster ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001185991698__section16834115141816"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185991698__table167492108193" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185991698__row2750131031910"><th align="left" class="cellrowborder" valign="top" width="27.400000000000002%" id="mcps1.3.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001185991698__p1750111061917"><strong id="EN-US_TOPIC_0000001185991698__b20537296318205">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.08%" id="mcps1.3.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001185991698__p375061016195"><strong id="EN-US_TOPIC_0000001185991698__b1924993111">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.33%" id="mcps1.3.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001185991698__p2750111021919"><strong id="EN-US_TOPIC_0000001185991698__b1507887481">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.19%" id="mcps1.3.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001185991698__p167501710161916"><strong id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_b1572911411225">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001185991698__row575019101199"><td class="cellrowborder" valign="top" width="27.400000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001185991698__p975091014199">keep_last_manual_snapshot</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.08%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001185991698__p87514104196">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.33%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001185991698__p1675191091916">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.19%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001185991698__p20751310131912">Keeps the latest manual snapshot.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001185991698__section624533861914"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000001185991698__p1754784341911">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_sa64d5fde1cb94be29689b1aab5bc2bb2"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0000001185991698__screen187389291883">DELETE https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
|
|
|
|
{
|
|
"keep_last_manual_snapshot" : 0
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_saf8285fea2964e558a059d985c498559"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000001185991698__p467262719211">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001098816628_s318da95b204f47c4bef42e78b54a9089"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185991698__en-us_topic_0000001437538221_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001185991698__row19681201142"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000001185991698__p10684110171418">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="EN-US_TOPIC_0000001185991698__p568511081420"><strong id="EN-US_TOPIC_0000001185991698__b757587536">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001185991698__row16681160111412"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185991698__p66856091416">202</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185991698__p76871081418">The cluster has been terminated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001185991698__row14681208148"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185991698__p196881703149">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185991698__p1668816019143">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001185991698__row116811606143"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185991698__p1689108148">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185991698__p368919014149">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001185991698__row1968216051412"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185991698__p769012018149">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185991698__p3690100191410">You do not have required permissions.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001185991698__row136821408147"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185991698__p56929012142">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185991698__p116924041415">No resources found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001185991698__row13682140121414"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185991698__p1669330191411">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185991698__p569480131413">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001185991698__row268280191415"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185991698__p1569414091415">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185991698__p1269500111411">Service unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0017.html">Managing Clusters</a></div>
|
|
</div>
|
|
</div>
|
|
|