doc-exports/docs/css/api-ref/css_03_0020.html
Zheng, Xiu 99a2d77599 css api 23.5.1 20240520
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com>
Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
2024-06-07 17:47:08 +00:00

94 lines
7.1 KiB
HTML

<a name="css_03_0020"></a><a name="css_03_0020"></a>
<h1 class="topictitle1">Deleting a Cluster</h1>
<div id="body1502957786212"><div class="section" id="css_03_0020__section13509138115714"><h4 class="sectiontitle">Function</h4><p id="css_03_0020__p21141114175617">This API is used to delete a cluster. All resources, including customer data, of the deleted cluster will be released. For data security reasons, create a snapshot for the cluster that you want to delete.</p>
</div>
<div class="section" id="css_03_0020__section156291613195618"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0020__screen1695846201113">DELETE /v1.0/{project_id}/clusters/{cluster_id}</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0020__table26299133563" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0020__row1511414148567"><th align="left" class="cellrowborder" valign="top" width="20.419999999999998%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0020__p201141114115617">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.1%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0020__p611491415563">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.67%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0020__p13114714165613">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.809999999999995%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0020__p81148146567">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0020__row7114141416564"><td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0020__p6114111455616">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.1%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0020__p91143149562">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0020__p111451435614">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0020__p16114201416568">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
<tr id="css_03_0020__row1911421445610"><td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0020__p12114214115615">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.1%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0020__p31141614165612">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0020__p111142014165613">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0020__p7114191425620">ID of the cluster to be deleted.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0020__section264581355617"><h4 class="sectiontitle">Request</h4><p id="css_03_0020__p7448195711281">None</p>
</div>
<div class="section" id="css_03_0020__section5645161395611"><h4 class="sectiontitle">Response</h4><p id="css_03_0020__p148122311115">None</p>
</div>
<div class="section" id="css_03_0020__section11872121315298"><h4 class="sectiontitle">Examples</h4><p id="css_03_0020__p1395111417297">Delete the cluster whose ID is <strong id="css_03_0020__b181671652143112">2a197c4d-5467-4003-931d-83ec49939cf</strong>.</p>
<p id="css_03_0020__p11141714195619">Example request</p>
<pre class="screen" id="css_03_0020__screen1114161418566">DELETE /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/2a197c4d-5467-4003-931d-83ec49939cf</pre>
<p id="css_03_0020__p155352197123">Example response</p>
<p id="css_03_0020__p1636011131682">The return value is empty.</p>
</div>
<div class="section" id="css_03_0020__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0020__p46921709171"><a href="#css_03_0020__table12321369178">Table 2</a> describes the status code.</p>
<div class="tablenoborder"><a name="css_03_0020__table12321369178"></a><a name="table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0020__table12321369178" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status codes</caption><thead align="left"><tr id="css_03_0020__en-us_topic_0000001342030725_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="15.939999999999998%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0020__en-us_topic_0000001342030725_p14560134151414">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31.04%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0020__en-us_topic_0000001342030725_p5563194141411">Message</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.02%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0020__en-us_topic_0000001342030725_p256616411143">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0020__en-us_topic_0000001342030725_row129720356144"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0020__en-us_topic_0000001342030725_p1957004131410">400</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0020__en-us_topic_0000001342030725_p165731141171419">BadRequest</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0020__en-us_topic_0000001342030725_p65778413148">Invalid request.</p>
<p id="css_03_0020__en-us_topic_0000001342030725_p1557974171415">Modify the request instead of retrying.</p>
</td>
</tr>
<tr id="css_03_0020__en-us_topic_0000001342030725_row8972103517147"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0020__en-us_topic_0000001342030725_p75841441191410">404</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0020__en-us_topic_0000001342030725_p258716416142">NotFound</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0020__en-us_topic_0000001342030725_p15589154118141">The requested resource cannot be found.</p>
<p id="css_03_0020__en-us_topic_0000001342030725_p14590164151410">Modify the request instead of retrying.</p>
</td>
</tr>
<tr id="css_03_0020__en-us_topic_0000001342030725_row297223511416"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0020__en-us_topic_0000001342030725_p13595164131416">200</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0020__en-us_topic_0000001342030725_p9598741131416">OK</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0020__en-us_topic_0000001342030725_p659994115146">The request is processed successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0008.html">Cluster Management APIs</a></div>
</div>
</div>