Files
doc-exports/docs/ucs/api-ref/DeleteClusterGroup.html
qiujiandong1 535e30e292 UCS API initial update 20250523 version
Reviewed-by: Gergo-Bence Lorincz <a200452876@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2026-02-23 09:12:31 +00:00

117 lines
8.4 KiB
HTML

<a name="DeleteClusterGroup"></a><a name="DeleteClusterGroup"></a>
<h1 class="topictitle1">Deleting a Fleet</h1>
<div id="body1224232312019"><div class="section" id="DeleteClusterGroup__section1824218233202"><h4 class="sectiontitle">Function</h4><p id="DeleteClusterGroup__p22435238202">This API is used to delete a fleet. A fleet can only be deleted when there are no clusters in it. To delete a fleet, remove the clusters from the fleet first. The cluster IDs must comply with the Kubernetes UUID format rules, and you must have operation permissions on the clusters. Otherwise, the authentication fails.</p>
</div>
<div class="section" id="DeleteClusterGroup__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p id="DeleteClusterGroup__p1224322313202">DELETE /v1/clustergroups/{clustergroupid}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteClusterGroup__table10244152342020" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="DeleteClusterGroup__row72441623122019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteClusterGroup__p10245132372018">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteClusterGroup__p12245023142018">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteClusterGroup__p12245142312201">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteClusterGroup__p024502352013">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteClusterGroup__row1524422382010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteClusterGroup__p124592382016">clustergroupid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteClusterGroup__p16246823192014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteClusterGroup__p1246162392020">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteClusterGroup__p7246132311203">Fleet ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteClusterGroup__section9246152372015"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteClusterGroup__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="DeleteClusterGroup__row024722342018"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteClusterGroup__p924772312015">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteClusterGroup__p224718236202">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteClusterGroup__p16247182311202">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteClusterGroup__p16247132332020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteClusterGroup__row7247162312011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteClusterGroup__p2247192302011">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteClusterGroup__p624772392013">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteClusterGroup__p8247923162012">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteClusterGroup__p1266617331861">Identity authentication information. Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token.</p>
</td>
</tr>
<tr id="DeleteClusterGroup__row81761913162117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteClusterGroup__p20110172212422">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteClusterGroup__p411018227429">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteClusterGroup__p7110152218429">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteClusterGroup__p12110172216422">Message body type (format). Only <strong id="DeleteClusterGroup__b172794838841721">application/json</strong> is supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteClusterGroup__section1824742342015"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteClusterGroup__p1224812312205">None</p>
</div>
<div class="section" id="DeleteClusterGroup__section1624852314209"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteClusterGroup__p102482237208">None</p>
</div>
<div class="section" id="DeleteClusterGroup__section13248182392013"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteClusterGroup__p719013345619"><strong id="DeleteClusterGroup__b150232801942021">Status code: 200</strong></p>
<p id="DeleteClusterGroup__p7190193420620">The fleet has been deleted.</p>
<pre class="screen" id="DeleteClusterGroup__screen51906341611">{ }</pre>
</div>
<div class="section" id="DeleteClusterGroup__section52481723152015"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteClusterGroup__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteClusterGroup__row82481523202010"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteClusterGroup__p162487230208">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteClusterGroup__p1524822342014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteClusterGroup__row5248132352012"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteClusterGroup__p62481023142015">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteClusterGroup__p824842310202">The fleet has been deleted.</p>
</td>
</tr>
<tr id="DeleteClusterGroup__row1424817235206"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteClusterGroup__p4249152332012">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteClusterGroup__p1624915233209">Client request error. The server could not execute the request.</p>
</td>
</tr>
<tr id="DeleteClusterGroup__row224822313208"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteClusterGroup__p162491623112017">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteClusterGroup__p12249223112016">The server refused the request.</p>
</td>
</tr>
<tr id="DeleteClusterGroup__row92487234201"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteClusterGroup__p924992313207">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteClusterGroup__p4249923152014">Resources not found.</p>
</td>
</tr>
<tr id="DeleteClusterGroup__row52481623192014"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteClusterGroup__p19249112332019">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteClusterGroup__p7249123182010">Internal server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteClusterGroup__section18249152311205"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteClusterGroup__p7249223112010">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Fleets</a></div>
</div>
</div>