vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/cce/api-ref/cce_02_0241.html
Dong, Qiu Jian 3bfd56205d CCE API update -20240401 version 
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
2024-04-16 09:26:07 +00:00

537 lines
54 KiB
HTML
Raw Blame History

<a name="cce_02_0241"></a><a name="cce_02_0241"></a>
<h1 class="topictitle1">Deleting a Specified Cluster</h1>
<div id="body1521448221833"><div class="section" id="cce_02_0241__section1686113493165"><h4 class="sectiontitle">Function</h4><p id="cce_02_0241__p209621357141610">This API is used to delete a specified cluster.</p>
<div class="note" id="cce_02_0241__note720141902219"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cce_02_0241__p1920131972213">The URL for cluster management is in the format of <strong id="cce_02_0241__b13527183913222">https://Endpoint/uri</strong>. In the URL, <strong id="cce_02_0241__b183662469223">uri</strong> indicates the resource path, that is, the path for API access.</p>
</div></div>
</div>
<div class="section" id="cce_02_0241__section8403243161416"><h4 class="sectiontitle">URI</h4><p id="cce_02_0241__p23575517439">DELETE /api/v3/projects/{project_id}/clusters/{cluster_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0241__table2027961241820" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="cce_02_0241__row122809120186"><th align="left" class="cellrowborder" valign="top" width="18.4981501849815%" id="mcps1.3.2.3.2.5.1.1"><p id="cce_02_0241__p91421758131813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.0988901109889%" id="mcps1.3.2.3.2.5.1.2"><p id="cce_02_0241__p101421758131816">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.649035096490351%" id="mcps1.3.2.3.2.5.1.3"><p id="cce_02_0241__p1566751214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.75392460753925%" id="mcps1.3.2.3.2.5.1.4"><p id="cce_02_0241__p19143115818187">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0241__row32801312121810"><td class="cellrowborder" valign="top" width="18.4981501849815%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cce_02_0241__p1714415589184">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cce_02_0241__p814518580186">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="9.649035096490351%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cce_02_0241__p195669582112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.75392460753925%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cce_02_0241__p5145175891811">Project ID. For details about how to obtain the project ID, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
</td>
</tr>
<tr id="cce_02_0241__row126417469411"><td class="cellrowborder" valign="top" width="18.4981501849815%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cce_02_0241__p5642046194113">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cce_02_0241__p146484634113">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="9.649035096490351%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cce_02_0241__p756616511213">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.75392460753925%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cce_02_0241__p664164613418">Cluster ID. For details about how to obtain the cluster ID, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0241__table1544019512197" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="cce_02_0241__row174408515194"><th align="left" class="cellrowborder" valign="top" width="18.4981501849815%" id="mcps1.3.2.4.2.5.1.1"><p id="cce_02_0241__p1544010517197">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.0988901109889%" id="mcps1.3.2.4.2.5.1.2"><p id="cce_02_0241__p1444015161910">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.649035096490351%" id="mcps1.3.2.4.2.5.1.3"><p id="cce_02_0241__p1018313373216">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.75392460753925%" id="mcps1.3.2.4.2.5.1.4"><p id="cce_02_0241__p644013512193">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0241__row18326417132413"><td class="cellrowborder" valign="top" width="18.4981501849815%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0241__p02849170246">errorStatus</p>
</td>
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0241__p1528411722419">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.649035096490351%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0241__p1284417112413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.75392460753925%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0241__p428418170247">This field allows a cluster to be in the Error state if exceptions occur when the cluster is being deleted. If the value of <strong id="cce_02_0241__b13515620142514">errorStatus</strong> is null, the cluster stays in the Deleting state, but not Error.</p>
<p id="cce_02_0241__p18284101712244">Minimum: <strong id="cce_02_0241__b1274182892519">0</strong></p>
<p id="cce_02_0241__p15284117112413">Maximum: <strong id="cce_02_0241__b98961336182517">10</strong></p>
</td>
</tr>
<tr id="cce_02_0241__row532610177246"><td class="cellrowborder" valign="top" width="18.4981501849815%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0241__p9285917132414">delete_efs</p>
</td>
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0241__p028517174249">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.649035096490351%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0241__p162857171240">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.75392460753925%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0241__p14285121719245">Whether to delete SFS Turbo resources. Value options:</p>
<ul id="cce_02_0241__ul9285111742411"><li id="cce_02_0241__li1028518178246"><strong id="cce_02_0241__b764857102614">true</strong> or <strong id="cce_02_0241__b169751716142611">block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li2028518178246"><strong id="cce_02_0241__b2811102512262">try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li628531718243"><strong id="cce_02_0241__b18511636172619">false</strong> or <strong id="cce_02_0241__b15271342172610">skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p82859176249">Default: <strong id="cce_02_0241__b544612517265">false</strong></p>
<p id="cce_02_0241__p19285171710249">Enumeration values:</p>
<ul id="cce_02_0241__ul82851317112417"><li id="cce_02_0241__li3285151792420"><strong id="cce_02_0241__b127751727102715">true</strong></li><li id="cce_02_0241__li12856174247"><strong id="cce_02_0241__b1377602762718">block</strong></li><li id="cce_02_0241__li5285121712419"><strong id="cce_02_0241__b1077712712273">try</strong></li><li id="cce_02_0241__li1928541702416"><strong id="cce_02_0241__b2778102742711">false</strong></li><li id="cce_02_0241__li728551712416"><strong id="cce_02_0241__b0779142720279">skip</strong></li></ul>
</td>
</tr>
<tr id="cce_02_0241__row1332611710248"><td class="cellrowborder" valign="top" width="18.4981501849815%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0241__p1428521792414">delete_eni</p>
</td>
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0241__p13285121715248">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.649035096490351%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0241__p228521732411">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.75392460753925%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0241__p1828571712247">Whether to delete ENI ports. Value options:</p>
<ul id="cce_02_0241__ul162853174241"><li id="cce_02_0241__li6285171742420"><strong id="cce_02_0241__b8142104182719">true</strong> or <strong id="cce_02_0241__b2531946182713">block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li13285181715243"><strong id="cce_02_0241__b886511531276">try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li3285161719248"><strong id="cce_02_0241__b142021319283">false</strong> or <strong id="cce_02_0241__b18591113272817">skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p18285161772419">Default: <strong id="cce_02_0241__b13171134162813">false</strong></p>
<p id="cce_02_0241__p11285017152413">Enumeration values:</p>
<ul id="cce_02_0241__ul7285151719246"><li id="cce_02_0241__li228517177248"><strong id="cce_02_0241__b518205114287">true</strong></li><li id="cce_02_0241__li122851217142417"><strong id="cce_02_0241__b31815122814">block</strong></li><li id="cce_02_0241__li14285191719246"><strong id="cce_02_0241__b13191951162818">try</strong></li><li id="cce_02_0241__li192851017182418"><strong id="cce_02_0241__b42035192812">false</strong></li><li id="cce_02_0241__li928591713241"><strong id="cce_02_0241__b920135112813">skip</strong></li></ul>
</td>
</tr>
<tr id="cce_02_0241__row11326017152415"><td class="cellrowborder" valign="top" width="18.4981501849815%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0241__p202851177246">delete_evs</p>
</td>
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0241__p22859174247">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.649035096490351%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0241__p13286161712411">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.75392460753925%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0241__p16286151732419">Whether to delete EVS disks. Value options:</p>
<ul id="cce_02_0241__ul6189548112919"><li id="cce_02_0241__li191891485292"><strong id="cce_02_0241__b161891048152917">true</strong> or <strong id="cce_02_0241__b19189144819299">block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li2189848182914"><strong id="cce_02_0241__b13190204810294">try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li1819054814299"><strong id="cce_02_0241__b1419074852919">false</strong> or <strong id="cce_02_0241__b719019480299">skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p4190204818293">Default: <strong id="cce_02_0241__b519014484298">false</strong></p>
<p id="cce_02_0241__p8190164812295">Enumeration values:</p>
<ul id="cce_02_0241__ul21901482299"><li id="cce_02_0241__li14190194816297"><strong id="cce_02_0241__b14193164812919">true</strong></li><li id="cce_02_0241__li1719315482299"><strong id="cce_02_0241__b619313486297">block</strong></li><li id="cce_02_0241__li11193164817294"><strong id="cce_02_0241__b1219354820291">try</strong></li><li id="cce_02_0241__li51931448142916"><strong id="cce_02_0241__b41931848132915">false</strong></li><li id="cce_02_0241__li51931548142913"><strong id="cce_02_0241__b12193154811294">skip</strong></li></ul>
</td>
</tr>
<tr id="cce_02_0241__row1632611742410"><td class="cellrowborder" valign="top" width="18.4981501849815%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0241__p62867171240">delete_net</p>
</td>
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0241__p1286131717248">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.649035096490351%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0241__p182864172244">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.75392460753925%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0241__p102866174240">Whether to delete cluster Service/ingress-related resources, such as ELB. Value options:</p>
<ul id="cce_02_0241__ul51761100306"><li id="cce_02_0241__li117610143017"><strong id="cce_02_0241__b151765019302">true</strong> or <strong id="cce_02_0241__b19176200103019">block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li71762006303"><strong id="cce_02_0241__b1817619010304">try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li91761306307"><strong id="cce_02_0241__b1117613043011">false</strong> or <strong id="cce_02_0241__b1917650143011">skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p6176100113011">Default: <strong id="cce_02_0241__b171761805304">false</strong></p>
<p id="cce_02_0241__p1917680193014">Enumeration values:</p>
<ul id="cce_02_0241__ul1217613003020"><li id="cce_02_0241__li1017611013013"><strong id="cce_02_0241__b9177102301">true</strong></li><li id="cce_02_0241__li171779019303"><strong id="cce_02_0241__b717718023012">block</strong></li><li id="cce_02_0241__li317740133017"><strong id="cce_02_0241__b1717740113017">try</strong></li><li id="cce_02_0241__li1017700193014"><strong id="cce_02_0241__b1317720153015">false</strong></li><li id="cce_02_0241__li8177110103013"><strong id="cce_02_0241__b11177130173011">skip</strong></li></ul>
</td>
</tr>
<tr id="cce_02_0241__row1325717182419"><td class="cellrowborder" valign="top" width="18.4981501849815%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0241__p102861417142415">delete_obs</p>
</td>
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0241__p128614177246">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.649035096490351%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0241__p728611752420">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.75392460753925%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0241__p162863170241">Whether to delete the OBS resources. Value options:</p>
<ul id="cce_02_0241__ul7522212183015"><li id="cce_02_0241__li5522121243019"><strong id="cce_02_0241__b165235120301">true</strong> or <strong id="cce_02_0241__b7523412123011">block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li7523171213309"><strong id="cce_02_0241__b165231412153015">try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li152311213302"><strong id="cce_02_0241__b13523812113013">false</strong> or <strong id="cce_02_0241__b95231112123011">skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p175231212143019">Default: <strong id="cce_02_0241__b2523312193012">false</strong></p>
<p id="cce_02_0241__p2052361217308">Enumeration values:</p>
<ul id="cce_02_0241__ul12523181273020"><li id="cce_02_0241__li11523181212304"><strong id="cce_02_0241__b145232123307">true</strong></li><li id="cce_02_0241__li125231412153016"><strong id="cce_02_0241__b11523012173012">block</strong></li><li id="cce_02_0241__li65233121306"><strong id="cce_02_0241__b0523121263016">try</strong></li><li id="cce_02_0241__li5523712113018"><strong id="cce_02_0241__b195231112163015">false</strong></li><li id="cce_02_0241__li16523312103012"><strong id="cce_02_0241__b1152371283019">skip</strong></li></ul>
</td>
</tr>
<tr id="cce_02_0241__row1232541762416"><td class="cellrowborder" valign="top" width="18.4981501849815%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0241__p62884170242">delete_sfs</p>
</td>
<td class="cellrowborder" valign="top" width="11.0988901109889%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0241__p728861702413">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.649035096490351%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0241__p92881617182416">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.75392460753925%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0241__p6288101717241">Whether to delete the SFS resources. Value options:</p>
<ul id="cce_02_0241__ul135361026183013"><li id="cce_02_0241__li14536226113016"><strong id="cce_02_0241__b1953622643015">true</strong> or <strong id="cce_02_0241__b185368260306">block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li185361326103014"><strong id="cce_02_0241__b175379267307">try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li175378267306"><strong id="cce_02_0241__b4537152615309">false</strong> or <strong id="cce_02_0241__b16537102643015">skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p2053742633010">Default: <strong id="cce_02_0241__b35377260306">false</strong></p>
<p id="cce_02_0241__p1453712615300">Enumeration values:</p>
<ul id="cce_02_0241__ul1537132614306"><li id="cce_02_0241__li75372026113017"><strong id="cce_02_0241__b853772615304">true</strong></li><li id="cce_02_0241__li15371226143016"><strong id="cce_02_0241__b18537102617303">block</strong></li><li id="cce_02_0241__li753718264307"><strong id="cce_02_0241__b953713268306">try</strong></li><li id="cce_02_0241__li195371026183011"><strong id="cce_02_0241__b15371826193017">false</strong></li><li id="cce_02_0241__li13537172610302"><strong id="cce_02_0241__b353722610303">skip</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cce_02_0241__section947084713911"><h4 class="sectiontitle">Request</h4><p id="cce_02_0241__p10314164115415"><strong id="cce_02_0241__b162259487412">Request parameters</strong>:</p>
<p id="cce_02_0241__p7105145203655"><a href="#cce_02_0241__table538113720514">Table 3</a> lists the request parameters.</p>
<div class="tablenoborder"><a name="cce_02_0241__table538113720514"></a><a name="table538113720514"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0241__table538113720514" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request header</caption><thead align="left"><tr id="cce_02_0241__en-us_topic_0102499074_row55001954122614"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.4.1.1"><p id="cce_02_0241__en-us_topic_0102499074_p115009545264">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.4.2.4.1.2"><p id="cce_02_0241__en-us_topic_0102499074_p175001547265">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61%" id="mcps1.3.3.4.2.4.1.3"><p id="cce_02_0241__en-us_topic_0102499074_p16500154162611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0241__en-us_topic_0102499074_row199801811203412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0241__en-us_topic_0102499074_p69808112344">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.4.2.4.1.2 "><p id="cce_02_0241__en-us_topic_0102499074_p3980111103414">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.4.1.3 "><p id="cce_02_0241__en-us_topic_0102499074_p169801011203416">Message body type (format). Possible values:</p>
<ul id="cce_02_0241__en-us_topic_0102499074_ul7385444163617"><li id="cce_02_0241__en-us_topic_0102499074_li18385114483612">application/json;charset=utf-8</li><li id="cce_02_0241__en-us_topic_0102499074_li3516132853714">application/json</li></ul>
</td>
</tr>
<tr id="cce_02_0241__en-us_topic_0102499074_row3500125412260"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0241__en-us_topic_0102499074_p105001654202618">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.4.2.4.1.2 "><p id="cce_02_0241__en-us_topic_0102499074_p20500954182618">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.4.1.3 "><p id="cce_02_0241__p18824197845">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. For details on how to obtain a user token, see <a href="cce_02_0004.html">API Usage Guidelines</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cce_02_0241__p1611232212217"><strong id="cce_02_0241__b18637103252113">Example request</strong>:</p>
<p id="cce_02_0241__p10992402120">N/A</p>
</div>
<div class="section" id="cce_02_0241__section61819725020"><h4 class="sectiontitle">Response</h4><p id="cce_02_0241__en-us_topic_0079614900_p2018733"><strong id="cce_02_0241__b183851459322">Response parameters</strong>:</p>
<p id="cce_02_0241__p16966318249"><a href="#cce_02_0241__en-us_topic_0079616779_en-us_topic_0079614912_ref458774242">Table 4</a> describes response parameters.</p>
<div class="tablenoborder"><a name="cce_02_0241__en-us_topic_0079616779_en-us_topic_0079614912_ref458774242"></a><a name="en-us_topic_0079616779_en-us_topic_0079614912_ref458774242"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0241__en-us_topic_0079616779_en-us_topic_0079614912_ref458774242" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="cce_02_0241__en-us_topic_0079616779_en-us_topic_0079614912_row38450714"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="cce_02_0241__en-us_topic_0079616779_en-us_topic_0079614912_p27500114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="cce_02_0241__p1654581422214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.4.4.2.4.1.3"><p id="cce_02_0241__p125451914132219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0241__en-us_topic_0079616779_en-us_topic_0079614912_row48220637"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0241__p108391536181311">kind</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0241__p1056311621716">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0241__p75781816181715">API type. The value is fixed at <strong id="cce_02_0241__b13220164154711">Cluster</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="cce_02_0241__row1698782994313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0241__p1785493610136">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0241__p757801610179">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0241__p12578616151718">API version. The value is fixed at <strong id="cce_02_0241__b89701633194715">v3</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="cce_02_0241__en-us_topic_0079616779_en-us_topic_0079614912_row28135397"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0241__p1185493615135">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0241__p11393144011425"><a href="cce_02_0236.html#cce_02_0236__table669019286188">metadata</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0241__p10343195011177">Cluster metadata, which is a collection of attributes.</p>
</td>
</tr>
<tr id="cce_02_0241__row125326326151"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0241__p6532732161518">spec</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0241__p1334385071712"><a href="cce_02_0236.html#cce_02_0236__table195921039143517">spec</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0241__p173598507179">Detailed description of the cluster targeted by this API. CCE creates or updates objects by defining or updating its spec.</p>
</td>
</tr>
<tr id="cce_02_0241__row22041436171514"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0241__p15204203610152">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0241__p1920413611513"><a href="#cce_02_0241__response_ClusterStatus">ClusterStatus</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0241__p9204133661512">Cluster status and jobID of the job that deletes a specified project.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0241__response_ClusterStatus"></a><a name="response_ClusterStatus"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0241__response_ClusterStatus" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ClusterStatus</caption><thead align="left"><tr id="cce_02_0241__row71891736931"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="cce_02_0241__p122161370311">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="cce_02_0241__p521611375320">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="cce_02_0241__p9216103710311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0241__row15189436333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0241__p13216143717315">phase</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0241__p20217123719317">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0241__p22171437034">Cluster status. Possible values:</p>
<ul id="cce_02_0241__ul1121717371435"><li id="cce_02_0241__li15217193712313"><strong id="cce_02_0241__b721712372315">Available</strong>: The cluster is running properly.</li><li id="cce_02_0241__li1821715376320"><strong id="cce_02_0241__b9217437532">Unavailable</strong>: The cluster is exhibiting unexpected behavior. Manually delete the cluster or contact the administrator to delete the cluster.</li><li id="cce_02_0241__li62171437835"><strong id="cce_02_0241__b221793719314">ScalingUp</strong>: Nodes are being added to the cluster.</li><li id="cce_02_0241__li3217153715310"><strong id="cce_02_0241__b10217103717313">ScalingDown</strong>: The cluster is being downsized to fewer nodes.</li><li id="cce_02_0241__li1021793711320"><strong id="cce_02_0241__b9217163710310">Creating</strong>: The cluster is being created.</li><li id="cce_02_0241__li13217837337"><strong id="cce_02_0241__b1821711373311">Deleting</strong>: The cluster is being deleted.</li><li id="cce_02_0241__li8217037834"><strong id="cce_02_0241__b16217193711320">Upgrading</strong>: The cluster is being upgraded.</li><li id="cce_02_0241__li1521793714319"><strong id="cce_02_0241__b62176375316">Resizing</strong>: Cluster specifications are being changed.</li><li id="cce_02_0241__li32172037231"><strong id="cce_02_0241__b921733715317">Empty</strong>: The cluster has no resources.</li></ul>
</td>
</tr>
<tr id="cce_02_0241__row1818973617314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0241__p221712371730">jobID</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0241__p62171337038">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0241__p5217123719320">Job ID.</p>
</td>
</tr>
<tr id="cce_02_0241__row151893365310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0241__p18217183716320">reason</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0241__p7217133716320">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0241__p521733713311">Reason of cluster state change. This parameter is returned if the cluster is not in the Available state.</p>
</td>
</tr>
<tr id="cce_02_0241__row619020367319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0241__p82171537132">message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0241__p182171137130">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0241__p621714375312">Detailed information about why the cluster changes to the current state. This parameter is returned if the cluster is not in the Available state.</p>
</td>
</tr>
<tr id="cce_02_0241__row6190113620314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0241__p1221893711319">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0241__p1821843710315"><a href="#cce_02_0241__response_ClusterEndpoints">ClusterEndpoints</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0241__p4218203718319">Access address of kube-apiserver in the cluster.</p>
</td>
</tr>
<tr id="cce_02_0241__row719010361639"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0241__p3218837036">deleteOption</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0241__p162183378310"><a href="#cce_02_0241__table1071610413396">deleteOption</a> Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0241__p1218153711317">Whether to delete configurations. This parameter is contained only in the response to the deletion request.</p>
</td>
</tr>
<tr id="cce_02_0241__row14190203615315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0241__p621819371032">deleteStatus</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0241__p102185374317"><a href="#cce_02_0241__table191928471414">deleteStatus</a> Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0241__p1221810371037">Whether to delete the status information. This parameter is contained only in the response to the deletion request.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0241__response_ClusterEndpoints"></a><a name="response_ClusterEndpoints"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0241__response_ClusterEndpoints" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ClusterEndpoints</caption><thead align="left"><tr id="cce_02_0241__row42121436232"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="cce_02_0241__p15218133714312">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="cce_02_0241__p221916376312">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="cce_02_0241__p62191372314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0241__row151714558442"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0241__p141176546446">internal</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0241__p81171654124413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0241__p18117155494420">Internal network address.</p>
</td>
</tr>
<tr id="cce_02_0241__row55161955174416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0241__p1511715546448">external</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0241__p16117254114411">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0241__p511719546447">External network address.</p>
</td>
</tr>
<tr id="cce_02_0241__row4516195514414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0241__p111171354104415">external_otc</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0241__p1211795434412">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0241__p61171454124418">Endpoint of the cluster to be accessed through API Gateway.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0241__table1071610413396"></a><a name="table1071610413396"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0241__table1071610413396" frame="border" border="1" rules="all"><caption><b>Table 7 </b>deleteOption</caption><thead align="left"><tr id="cce_02_0241__row137169418398"><th align="left" class="cellrowborder" valign="top" width="19.541954195419542%" id="mcps1.3.4.7.2.4.1.1"><p id="cce_02_0241__p1289214146399">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.102010201020104%" id="mcps1.3.4.7.2.4.1.2"><p id="cce_02_0241__p98928144397">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.35603560356036%" id="mcps1.3.4.7.2.4.1.3"><p id="cce_02_0241__p589215143397">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0241__row15716442392"><td class="cellrowborder" valign="top" width="19.541954195419542%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0241__p171624143915">delete_sfs</p>
</td>
<td class="cellrowborder" valign="top" width="20.102010201020104%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0241__p1371684163913">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.35603560356036%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0241__p193742781210">Whether to delete SFS Turbo resources. Value options:</p>
<ul id="cce_02_0241__ul5371527201211"><li id="cce_02_0241__li237162701219"><strong id="cce_02_0241__b6371327141217">delete-true</strong> or <strong id="cce_02_0241__b1537132741218">delete-block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li1037162713121"><strong id="cce_02_0241__b123718275125">delete-try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li737182761220"><strong id="cce_02_0241__b5371127191210">delete-false</strong> or <strong id="cce_02_0241__b93714275121">delete-skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p3377276127">Default: <strong id="cce_02_0241__b2037122714121">delete-false</strong></p>
<p id="cce_02_0241__p153772781215">Enumeration values:</p>
<ul id="cce_02_0241__ul1937327171219"><li id="cce_02_0241__li1537627151219"><strong id="cce_02_0241__b73732717123">delete-true</strong></li><li id="cce_02_0241__li637102711126"><strong id="cce_02_0241__b9371727201217">delete-block</strong></li><li id="cce_02_0241__li10370270124"><strong id="cce_02_0241__b203762771213">delete-try</strong></li><li id="cce_02_0241__li7371827171215"><strong id="cce_02_0241__b12372277129">delete-false</strong></li><li id="cce_02_0241__li18371427151219"><strong id="cce_02_0241__b1037122719121">delete-skip</strong></li></ul>
</td>
</tr>
<tr id="cce_02_0241__row9716174113910"><td class="cellrowborder" valign="top" width="19.541954195419542%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0241__p167161844390">delete_eni</p>
</td>
<td class="cellrowborder" valign="top" width="20.102010201020104%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0241__p1871614417390">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.35603560356036%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0241__p1637162711129">Whether to delete ENI ports. Value options:</p>
<ul id="cce_02_0241__ul173715274122"><li id="cce_02_0241__li1337127161212"><strong id="cce_02_0241__b937127161218">delete-true</strong> or <strong id="cce_02_0241__b93752710123">delete-block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li17371527191218"><strong id="cce_02_0241__b737142720129">delete-try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li1437102714124"><strong id="cce_02_0241__b23719273121">delete-false</strong> or <strong id="cce_02_0241__b113792715121">delete-skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p537112711122">Default: <strong id="cce_02_0241__b143752781217">delete-false</strong></p>
<p id="cce_02_0241__p1337192791217">Enumeration values:</p>
<ul id="cce_02_0241__ul737152791216"><li id="cce_02_0241__li93792714121"><strong id="cce_02_0241__b5373275122">delete-true</strong></li><li id="cce_02_0241__li83752715123"><strong id="cce_02_0241__b33714274128">delete-block</strong></li><li id="cce_02_0241__li53722751217"><strong id="cce_02_0241__b113792751217">delete-try</strong></li><li id="cce_02_0241__li1737427111215"><strong id="cce_02_0241__b63702741210">delete-false</strong></li><li id="cce_02_0241__li13702791220"><strong id="cce_02_0241__b737132701215">delete-skip</strong></li></ul>
</td>
</tr>
<tr id="cce_02_0241__row3716174153910"><td class="cellrowborder" valign="top" width="19.541954195419542%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0241__p1571613419398">delete_evs</p>
</td>
<td class="cellrowborder" valign="top" width="20.102010201020104%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0241__p171612414391">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.35603560356036%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0241__p1337122791212">Whether to delete EVS disks. Value options:</p>
<ul id="cce_02_0241__ul13371327201216"><li id="cce_02_0241__li637122781211"><strong id="cce_02_0241__b18374276128">delete-true</strong> or <strong id="cce_02_0241__b137112716129">delete-block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li937927161218"><strong id="cce_02_0241__b12371427141219">delete-try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li1437152712120"><strong id="cce_02_0241__b113792761217">delete-false</strong> or <strong id="cce_02_0241__b837172791218">delete-skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p1637202718126">Default: <strong id="cce_02_0241__b13792712120">delete-false</strong></p>
<p id="cce_02_0241__p53782781212">Enumeration values:</p>
<ul id="cce_02_0241__ul73713279122"><li id="cce_02_0241__li6374273126"><strong id="cce_02_0241__b19371027151220">delete-true</strong></li><li id="cce_02_0241__li1537202711217"><strong id="cce_02_0241__b337172711214">delete-block</strong></li><li id="cce_02_0241__li83742761218"><strong id="cce_02_0241__b173742715124">delete-try</strong></li><li id="cce_02_0241__li16371927111210"><strong id="cce_02_0241__b143782711210">delete-false</strong></li><li id="cce_02_0241__li1537152771211"><strong id="cce_02_0241__b123722711126">delete-skip</strong></li></ul>
</td>
</tr>
<tr id="cce_02_0241__row171684153915"><td class="cellrowborder" valign="top" width="19.541954195419542%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0241__p97161341399">delete_net</p>
</td>
<td class="cellrowborder" valign="top" width="20.102010201020104%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0241__p27163416391">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.35603560356036%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0241__p133752718123">Whether to delete cluster Service/ingress-related resources, such as ELB. Value options:</p>
<ul id="cce_02_0241__ul437927151213"><li id="cce_02_0241__li73820278125"><strong id="cce_02_0241__b10381527101218">delete-true</strong> or <strong id="cce_02_0241__b93812279129">delete-block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li11381727191217"><strong id="cce_02_0241__b13382027101211">delete-try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li173832751214"><strong id="cce_02_0241__b638227141212">delete-false</strong> or <strong id="cce_02_0241__b1538132720129">delete-skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p183862711125">Default: <strong id="cce_02_0241__b1038152715126">delete-false</strong></p>
<p id="cce_02_0241__p183819272129">Enumeration values:</p>
<ul id="cce_02_0241__ul1338102712121"><li id="cce_02_0241__li1738127161219"><strong id="cce_02_0241__b20381278126">delete-true</strong></li><li id="cce_02_0241__li1338142717129"><strong id="cce_02_0241__b1638142741211">delete-block</strong></li><li id="cce_02_0241__li1381027111214"><strong id="cce_02_0241__b1438122710123">delete-try</strong></li><li id="cce_02_0241__li1838427121213"><strong id="cce_02_0241__b43852715124">delete-false</strong></li><li id="cce_02_0241__li173815278121"><strong id="cce_02_0241__b1638527111218">delete-skip</strong></li></ul>
</td>
</tr>
<tr id="cce_02_0241__row1071619463920"><td class="cellrowborder" valign="top" width="19.541954195419542%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0241__p871614153916">delete_obs</p>
</td>
<td class="cellrowborder" valign="top" width="20.102010201020104%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0241__p16716184133910">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.35603560356036%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0241__p838132771215">Whether to delete the OBS resources. Value options:</p>
<ul id="cce_02_0241__ul123812718120"><li id="cce_02_0241__li23832781216"><strong id="cce_02_0241__b6381827171213">delete-true</strong> or <strong id="cce_02_0241__b238427141216">delete-block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li1038527151218"><strong id="cce_02_0241__b1038102711122">delete-try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li2381627151216"><strong id="cce_02_0241__b1438142761213">delete-false</strong> or <strong id="cce_02_0241__b1338727171217">delete-skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p838102711212">Default: <strong id="cce_02_0241__b9386273126">delete-false</strong></p>
<p id="cce_02_0241__p133832761211">Enumeration values:</p>
<ul id="cce_02_0241__ul19381927141215"><li id="cce_02_0241__li1638927201217"><strong id="cce_02_0241__b8381827161215">delete-true</strong></li><li id="cce_02_0241__li143819279126"><strong id="cce_02_0241__b438627121210">delete-block</strong></li><li id="cce_02_0241__li193852741216"><strong id="cce_02_0241__b163892719129">delete-try</strong></li><li id="cce_02_0241__li113814275128"><strong id="cce_02_0241__b1838727131217">delete-false</strong></li><li id="cce_02_0241__li1538327181217"><strong id="cce_02_0241__b138127161215">delete-skip</strong></li></ul>
</td>
</tr>
<tr id="cce_02_0241__row6486910204110"><td class="cellrowborder" valign="top" width="19.541954195419542%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0241__p17487141018412">delete_sfs</p>
</td>
<td class="cellrowborder" valign="top" width="20.102010201020104%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0241__p348741054112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.35603560356036%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0241__p13818270123">Whether to delete the SFS resources. Value options:</p>
<ul id="cce_02_0241__ul538172771212"><li id="cce_02_0241__li1238827151219"><strong id="cce_02_0241__b1238162720128">delete-true</strong> or <strong id="cce_02_0241__b1738182713128">delete-block</strong> (The system starts to delete the object. If the deletion fails, subsequent processes are blocked.)</li><li id="cce_02_0241__li103814273128"><strong id="cce_02_0241__b19381827151211">delete-try</strong> (The system starts to delete the object. If the deletion fails, no deletion retry is performed, and subsequent processes are not blocked.)</li><li id="cce_02_0241__li738142718126"><strong id="cce_02_0241__b123814276126">delete-false</strong> or <strong id="cce_02_0241__b1738027191218">delete-skip</strong> (The object is not deleted. These are the default value options.)</li></ul>
<p id="cce_02_0241__p1838627141213">Default: <strong id="cce_02_0241__b03822716122">delete-false</strong></p>
<p id="cce_02_0241__p83852711125">Enumeration values:</p>
<ul id="cce_02_0241__ul1338122719122"><li id="cce_02_0241__li638162718125"><strong id="cce_02_0241__b1138192716128">delete-true</strong></li><li id="cce_02_0241__li13852718125"><strong id="cce_02_0241__b4381927141214">delete-block</strong></li><li id="cce_02_0241__li143812276124"><strong id="cce_02_0241__b2381827181212">delete-try</strong></li><li id="cce_02_0241__li17381527111214"><strong id="cce_02_0241__b1838427101211">delete-false</strong></li><li id="cce_02_0241__li738122791217"><strong id="cce_02_0241__b63832791217">delete-skip</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0241__table191928471414"></a><a name="table191928471414"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0241__table191928471414" frame="border" border="1" rules="all"><caption><b>Table 8 </b>deleteStatus</caption><thead align="left"><tr id="cce_02_0241__row5192114711415"><th align="left" class="cellrowborder" valign="top" width="19.571957195719573%" id="mcps1.3.4.8.2.4.1.1"><p id="cce_02_0241__p4233175114217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.82198219821982%" id="mcps1.3.4.8.2.4.1.2"><p id="cce_02_0241__p11921947194115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.60606060606061%" id="mcps1.3.4.8.2.4.1.3"><p id="cce_02_0241__p17192647134120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0241__row61921247114111"><td class="cellrowborder" valign="top" width="19.571957195719573%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0241__p359513316527">previous_total</p>
</td>
<td class="cellrowborder" valign="top" width="19.82198219821982%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0241__p7595333165212">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.60606060606061%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0241__p4595163385218">Total number of existing cluster resource records when the cluster is deleted.</p>
</td>
</tr>
<tr id="cce_02_0241__row319204717415"><td class="cellrowborder" valign="top" width="19.571957195719573%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0241__p959563312522">current_total</p>
</td>
<td class="cellrowborder" valign="top" width="19.82198219821982%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0241__p18595143312523">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.60606060606061%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0241__p16595193319527">Latest number of resource records, which is generated based on the current cluster resource records.</p>
</td>
</tr>
<tr id="cce_02_0241__row919217473417"><td class="cellrowborder" valign="top" width="19.571957195719573%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0241__p135954337528">updated</p>
</td>
<td class="cellrowborder" valign="top" width="19.82198219821982%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0241__p1359643317521">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.60606060606061%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0241__p1059616334524">Total number of resource records updated when the cluster is deleted.</p>
</td>
</tr>
<tr id="cce_02_0241__row9192247134114"><td class="cellrowborder" valign="top" width="19.571957195719573%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0241__p259663310529">added</p>
</td>
<td class="cellrowborder" valign="top" width="19.82198219821982%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0241__p359612336528">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.60606060606061%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0241__p9596433125215">Total number of resource records updated when the cluster is deleted.</p>
</td>
</tr>
<tr id="cce_02_0241__row619244711419"><td class="cellrowborder" valign="top" width="19.571957195719573%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0241__p175965334527">deleted</p>
</td>
<td class="cellrowborder" valign="top" width="19.82198219821982%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0241__p1759613339527">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.60606060606061%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0241__p359623365218">Total number of resource records deleted when the cluster is deleted.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="p" id="cce_02_0241__en-us_topic_0079614900_p24465425"><strong id="cce_02_0241__b102614283518">Response example</strong>:<pre class="screen" id="cce_02_0241__screen1294114619285">{
"kind": "Cluster",
"apiVersion": "v3",
"metadata": {
"name": "mycluster",
"uid": "7a661f82-90d9-11ea-9f85-0255ac10110d",
"creationTimestamp": "2020-05-08 03:10:32.403757 +0000 UTC",
"updateTimestamp": "2020-05-08 03:18:29.238331 +0000 UTC"
},
"spec": {
"type": "VirtualMachine",
"flavor": "cce.s1.small",
"version": "v1.17.9-r0",
"az": "eu-de-01",
"ipv6enable": false,
"supportIstio": true,
"hostNetwork": {
"vpc": "23d3725f-6ffe-400e-8fb6-b4f9a7b3e8c1",
"subnet": "c90b3ce5-e1f1-4c87-a006-644d78846438",
"SecurityGroup": "11fb88d1-0fc9-422d-963d-374ababa5f57"
},
"containerNetwork": {
"mode": "overlay_l2",
"cidr": "172.16.0.0/16"
},
"authentication": {
"mode": "rbac",
"authenticatingProxy": {}
},
"billingMode": 0,
"extendParam": {
"alpha.cce/fixPoolMask": "",
"kubernetes.io/cpuManagerPolicy": "",
"upgradefrom": ""
},
"kubernetesSvcIpRange": "10.247.0.0/16",
"kubeProxyMode": "iptables"
},
"status": {
"phase": "Available",
"jobID": "f5fd8cbf-90db-11ea-9f85-0255ac10110d",
"endpoints": {
"Internal": "https://192.168.0.61:5443",
"External": "https://10.185.69.54:5443",
"external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com"
},
"deleteOption": {
"delete_eni": "delete-skip",
"delete_net": "delete-block",
"delete_evs": "delete-skip",
"delete_sfs": "delete-skip",
"delete_obs": "delete-skip",
"delete_efs": "delete-skip"
},
"deleteStatus": {
"previous_total": 0,
"current_total": 15,
"updated": 0,
"added": 15,
"deleted": 0
}
}
}</pre>
</div>
</div>
<div class="section" id="cce_02_0241__s50f1049a6a4d404c895cf636eb8f3bf1"><h4 class="sectiontitle">Status Code</h4><p id="cce_02_0241__en-us_topic_0079614900_p21869221"><a href="#cce_02_0241__en-us_topic_0079614900_table46761928">Table 9</a> describes the status code of this API.</p>
<div class="tablenoborder"><a name="cce_02_0241__en-us_topic_0079614900_table46761928"></a><a name="en-us_topic_0079614900_table46761928"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0241__en-us_topic_0079614900_table46761928" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Status code</caption><thead align="left"><tr id="cce_02_0241__en-us_topic_0079614900_row33254664"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.3.1.1"><p id="cce_02_0241__p55616028205955">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.3.1.2"><p id="cce_02_0241__p8604418205955">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0241__en-us_topic_0079614900_row41084259"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.3.1.1 "><p id="cce_02_0241__en-us_topic_0079614900_p39490674">200</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.3.1.2 "><p id="cce_02_0241__en-us_topic_0079614900_p44628050">The job for deleting a cluster is successfully delivered.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cce_02_0241__p347213715512">For details about error status codes, see <a href="cce_02_0084.html">Status Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0092.html">Cluster Management</a></div>
</div>
</div>
View Git Blame Copy Permalink