forked from docs/doc-exports
zhengxiu
8f6b8d3664
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: zhengxiu <zhengxiu@huawei.com> Co-committed-by: zhengxiu <zhengxiu@huawei.com>
106 lines
7.8 KiB
HTML
106 lines
7.8 KiB
HTML
<a name="DeleteCluster"></a><a name="DeleteCluster"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Cluster</h1>
|
|
<div id="body1708331107508"><div class="section" id="DeleteCluster__section1516182864810"><h4 class="sectiontitle">Function</h4><p id="DeleteCluster__p91611628114817">This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluster, create a snapshot before deleting the cluster.</p>
|
|
<div class="note" id="DeleteCluster__note21612028194813"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="DeleteCluster__p21611286480">Clusters frozen for public security reasons cannot be deleted. Deleting a cluster will also clear its data. Exercise caution.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="DeleteCluster__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="DeleteCluster__p416292813483">For details, see <a href="css_03_0077.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="DeleteCluster__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="DeleteCluster__p5162162811485">DELETE /v1.0/{project_id}/clusters/{cluster_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__table716232816489" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteCluster__row1716232814820"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="DeleteCluster__p7162122811484">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="DeleteCluster__p4162428114816">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="DeleteCluster__p1316212810489">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="DeleteCluster__p616212874814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteCluster__row1416262874817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="DeleteCluster__p16163122874811">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="DeleteCluster__p1816302815483">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="DeleteCluster__p3163152812482">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="DeleteCluster__p1316362874810"><strong id="DeleteCluster__b2163152864820">Definition</strong>:</p>
|
|
<p id="DeleteCluster__p171637283488">Project ID. For details about how to obtain the project ID and name, see <a href="css_03_0071.html">Obtaining the Project ID and Name</a>.</p>
|
|
<p id="DeleteCluster__p1616342814485"><strong id="DeleteCluster__b1716342817489">Constraints</strong>:</p>
|
|
<p id="DeleteCluster__p2016362894812">N/A</p>
|
|
<p id="DeleteCluster__p81631128114818"><strong id="DeleteCluster__b121633285482">Value range</strong>:</p>
|
|
<p id="DeleteCluster__p3163428114812">Project ID of the account.</p>
|
|
<p id="DeleteCluster__p11631328154818"><strong id="DeleteCluster__b1016319288486">Default value</strong>:</p>
|
|
<p id="DeleteCluster__p3163152811484">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteCluster__row101621028174813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="DeleteCluster__p1416312815484">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="DeleteCluster__p4163202864819">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="DeleteCluster__p316392811485">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="DeleteCluster__p2163132804816"><strong id="DeleteCluster__b1416318280483">Definition</strong>:</p>
|
|
<p id="DeleteCluster__p181636280485">ID of the cluster you want to delete. For details about how to obtain the cluster ID, see <a href="css_03_0101.html">Obtaining the Cluster ID</a>.</p>
|
|
<p id="DeleteCluster__p4163228114815"><strong id="DeleteCluster__b1516332814481">Constraints</strong>:</p>
|
|
<p id="DeleteCluster__p316319283485">N/A</p>
|
|
<p id="DeleteCluster__p7163028204819"><strong id="DeleteCluster__b81636288483">Value range</strong>:</p>
|
|
<p id="DeleteCluster__p141632287484">Cluster ID.</p>
|
|
<p id="DeleteCluster__p7163928164818"><strong id="DeleteCluster__b18163172844814">Default value</strong>:</p>
|
|
<p id="DeleteCluster__p116352816486">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="DeleteCluster__section51641828184813"><h4 class="sectiontitle">Request Parameters</h4><p id="DeleteCluster__p181641628124814">None</p>
|
|
</div>
|
|
<div class="section" id="DeleteCluster__section1016417282483"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteCluster__p216482864810"><strong id="DeleteCluster__b71640287486">Status code: 200</strong></p>
|
|
<p id="DeleteCluster__p14164122817486">Request succeeded.</p>
|
|
<p id="DeleteCluster__p41646283484">None</p>
|
|
</div>
|
|
<div class="section" id="DeleteCluster__section20164182812489"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteCluster__p11164162814482">Delete a cluster.</p>
|
|
<pre class="screen" id="DeleteCluster__screen191641828134814">DELETE https://{Endpoint}/v1.0/{project_id}/clusters/2a197c4d-5467-4003-931d-83ec49939cf</pre>
|
|
</div>
|
|
<div class="section" id="DeleteCluster__section14164928154818"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteCluster__p10164172854815">None</p>
|
|
</div>
|
|
<div class="section" id="DeleteCluster__section7169132811486"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteCluster__row1116952819488"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="DeleteCluster__p316972814488">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="DeleteCluster__p81691428114810">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteCluster__row6169112816482"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="DeleteCluster__p1216914289489">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="DeleteCluster__p1316920280482">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteCluster__row9169122834814"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="DeleteCluster__p1916911286489">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="DeleteCluster__p111697283486">Invalid request.</p>
|
|
<p id="DeleteCluster__p15169142814486">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteCluster__row1916982815487"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="DeleteCluster__p1116922814816">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="DeleteCluster__p17170102813481">The requested resource could not be found.</p>
|
|
<p id="DeleteCluster__p1017092819485">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="DeleteCluster__section1517052874810"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteCluster__p1117012281489">See <a href="css_03_0076.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="cluster_management.html">Cluster Management</a></div>
|
|
</div>
|
|
</div>
|
|
|