yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a2e28c76231c99d8bbac87147becbb2b7e6be32e
doc-exports/docs/ucs/api-ref/DeleteCluster.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

191 lines
13 KiB
HTML
Raw Blame History

<a name="DeleteCluster"></a><a name="DeleteCluster"></a>
<h1 class="topictitle1">Unregistering a Cluster</h1>
<div id="body7865823181710"><div class="section" id="DeleteCluster__section1486542316173"><h4 class="sectiontitle">Function</h4><p id="DeleteCluster__p386510234173">This API is used to unregister a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permissions on the corresponding cluster. Otherwise, the authentication fails.</p>
</div>
<div class="section" id="DeleteCluster__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p id="DeleteCluster__p1186592313179">DELETE /v1/clusters/{clusterid}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__table98661123111716" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="DeleteCluster__row28656237171"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteCluster__p1986662311170">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteCluster__p586682319175">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteCluster__p1586620233171">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteCluster__p28661823141716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteCluster__row186522312174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteCluster__p1586602311715">clusterid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteCluster__p38661123171712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteCluster__p108666239178">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteCluster__p486619239172">Cluster ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteCluster__section1686682351711"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="DeleteCluster__row1086622301719"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteCluster__p78679238172">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteCluster__p8867723111719">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteCluster__p7867323161714">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteCluster__p168671823161713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteCluster__row38661323121718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteCluster__p286717234179">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteCluster__p586702341719">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteCluster__p13867523141713">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteCluster__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="DeleteCluster__row17287530161917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteCluster__p20110172212422">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteCluster__p411018227429">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteCluster__p7110152218429">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteCluster__p12110172216422">Message body type (format). Only <strong id="DeleteCluster__b84466550841717">application/json</strong> is supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteCluster__section5867112361719"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteCluster__p1319362212420"><strong id="DeleteCluster__b19736977752468">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__response_-" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter in the response body</caption><thead align="left"><tr id="DeleteCluster__row1119352215428"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteCluster__p9194152210426">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteCluster__p17194132218429">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteCluster__p31941722144216">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteCluster__row1819382264216"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteCluster__p51941822164220">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteCluster__p141942224421">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteCluster__p2018745853610">The cluster has been unregistered.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteCluster__p81940224424"><strong id="DeleteCluster__b169420230324715">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__table15194162264212" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter in the response body</caption><thead align="left"><tr id="DeleteCluster__row1419416227424"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="DeleteCluster__p12194202218423">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="DeleteCluster__p619416224429">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="DeleteCluster__p319516220424">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteCluster__row161941222104219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="DeleteCluster__p1519562244215">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="DeleteCluster__p8195172213429">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="DeleteCluster__p10195202274219">-</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteCluster__p419592214425"><strong id="DeleteCluster__b17181923124914">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__table1619519223427" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter in the response body</caption><thead align="left"><tr id="DeleteCluster__row11951722204214"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="DeleteCluster__p319562210424">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="DeleteCluster__p019552213421">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="DeleteCluster__p1719532211424">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteCluster__row6195122244219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="DeleteCluster__p1119552210424">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="DeleteCluster__p10195192212421">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="DeleteCluster__p51951225428">-</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteCluster__p1519692210428"><strong id="DeleteCluster__b435931024745">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__table1919652264219" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter in the response body</caption><thead align="left"><tr id="DeleteCluster__row121967224421"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.1"><p id="DeleteCluster__p8196202244214">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.2"><p id="DeleteCluster__p91967222428">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.9.2.4.1.3"><p id="DeleteCluster__p1119620223429">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteCluster__row20196622174214"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="DeleteCluster__p17196172224215">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="DeleteCluster__p9196202213425">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="DeleteCluster__p419642215421">-</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteCluster__section886711236176"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteCluster__p9867122311713">None</p>
</div>
<div class="section" id="DeleteCluster__section1586762312174"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteCluster__p719013345619"><strong id="DeleteCluster__b173789305342019">Status code: 200</strong></p>
<p id="DeleteCluster__p7190193420620">The cluster has been unregistered.</p>
<pre class="screen" id="DeleteCluster__screen51906341611">{ }</pre>
</div>
<div class="section" id="DeleteCluster__section20868223121715"><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__row1286812311179"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteCluster__p1986852320174">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteCluster__p138681023101713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteCluster__row78685239172"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteCluster__p786818236178">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteCluster__p5868142391719">The cluster has been unregistered.</p>
</td>
</tr>
<tr id="DeleteCluster__row2086842311711"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteCluster__p0868323151713">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteCluster__p1286832312173">Client request error. The server could not execute the request.</p>
</td>
</tr>
<tr id="DeleteCluster__row486842310177"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteCluster__p20868923131719">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteCluster__p1986815238174">Resources not found.</p>
</td>
</tr>
<tr id="DeleteCluster__row198681236175"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteCluster__p98691523201719">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteCluster__p786982313176">Internal server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteCluster__section28693233174"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteCluster__p286919239173">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_300000000.html">UCS Clusters</a></div>
</div>
</div>
View Git Blame Copy Permalink