Files
doc-exports/docs/cce/api-ref/DeleteRelease.html
qiujiandong1 ebc8247e23 CCE API update 20250114 version
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2025-03-05 16:51:16 +00:00

262 lines
19 KiB
HTML

<a name="DeleteRelease"></a><a name="DeleteRelease"></a>
<h1 class="topictitle1">Deleting a Release</h1>
<div id="body32001227"><div class="section" id="DeleteRelease__section147391745175517"><h4 class="sectiontitle">Function</h4><p id="DeleteRelease__p2739114565511">This API is used to delete a release.</p>
</div>
<div class="section" id="DeleteRelease__en-us_topic_0000001896008885_atuogenerate_1"><h4 class="sectiontitle">URI</h4><p id="DeleteRelease__p197401445195517">DELETE /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteRelease__table474274517558" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteRelease__row1374084535511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteRelease__p074344518550">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteRelease__p1574316458555">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteRelease__p874320453552">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteRelease__p0743164511556">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteRelease__row5741104525512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteRelease__p474474516556">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteRelease__p147441545125518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteRelease__p17744134555516">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteRelease__p97459457555">Release name</p>
</td>
</tr>
<tr id="DeleteRelease__row10741144518551"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteRelease__p1574534595517">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteRelease__p87452454554">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteRelease__p20746124516556">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteRelease__p87467456557">Namespace of the chart</p>
</td>
</tr>
<tr id="DeleteRelease__row774114515519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteRelease__p274654575517">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteRelease__p1774674595514">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteRelease__p4747194519553">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteRelease__p1974764516557">Cluster ID. For details about how to obtain the value, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteRelease__section137471945115516"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteRelease__en-us_topic_0000001896008885_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="DeleteRelease__row197489453555"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteRelease__p18749445195515">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteRelease__p147491545115511">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteRelease__p874913453558">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteRelease__p197501545155512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteRelease__row7748124511556"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteRelease__p9750745155514">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteRelease__p4750164585513">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteRelease__p1175016453558">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteRelease__p175132048141618">Details:</p>
<p id="DeleteRelease__p1513184851611">Request body type or format.</p>
<p id="DeleteRelease__p363312163118">Constraints:</p>
<p id="DeleteRelease__p86331116121112">The GET method is not verified.</p>
<p id="DeleteRelease__p36336166115">Options:</p>
<ul id="DeleteRelease__ul166331116111111"><li id="DeleteRelease__li6633516101110">application/json</li><li id="DeleteRelease__li1363351614116">application/json;charset=utf-8</li><li id="DeleteRelease__li0633191617110">application/x-pem-file</li><li id="DeleteRelease__li192591549143012">multipart/form-data (It can be used when the <strong id="DeleteRelease__uploadchart_b1058912225107">FormData</strong> parameter exists.)</li></ul>
<p id="DeleteRelease__p363331671112">Default value:</p>
<p id="DeleteRelease__p5633151617112">N/A</p>
</td>
</tr>
<tr id="DeleteRelease__row197486455557"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteRelease__p17751204595510">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteRelease__p13751745125513">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteRelease__p0751345205517">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteRelease__p5751114514557">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, see <a href="cce_02_0004.html">API Usage Guidelines</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteRelease__section8752144575510"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteRelease__p18752164515519"><strong id="DeleteRelease__b1767993219248">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteRelease__response_ReleaseResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="DeleteRelease__row11679143214249"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteRelease__p86801132202417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteRelease__p36801532132414">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteRelease__p1068019327246">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteRelease__row767912329241"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p1368015326249">chart_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p106801932192416">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p86801532172418">Chart name</p>
</td>
</tr>
<tr id="DeleteRelease__row1167973262419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p156801332102419">chart_public</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p12680173215243">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p668015323240">Whether the chart is public</p>
</td>
</tr>
<tr id="DeleteRelease__row12679133218248"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p17680203292414">chart_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p1568015328241">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p166801932152418">Chart version</p>
</td>
</tr>
<tr id="DeleteRelease__row156791325245"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p1668010326242">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p116806321243">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p166801332112415">Cluster ID</p>
</td>
</tr>
<tr id="DeleteRelease__row156793328249"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p14680232152416">cluster_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p368014329240">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p14680123219241">Current name</p>
</td>
</tr>
<tr id="DeleteRelease__row11679163242418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p14680113219247">create_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p156811332122413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p3681163202413">Created at</p>
</td>
</tr>
<tr id="DeleteRelease__row12679193220242"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p1268113215246">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p18681193262413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p1068233232414">Release description</p>
</td>
</tr>
<tr id="DeleteRelease__row9680103292410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p468293252415">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p468218321246">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p15682193232418">Release name</p>
</td>
</tr>
<tr id="DeleteRelease__row468013262413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p16682132162414">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p1168253212247">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p176821732102414">Namespace to which a chart release belongs</p>
</td>
</tr>
<tr id="DeleteRelease__row26803323243"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p968233212413">parameters</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p126827328247">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p1568233252410">Release parameters</p>
</td>
</tr>
<tr id="DeleteRelease__row1968003218241"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p126828322240">resources</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p4682163215241">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p1568293282411">Resources required by the release</p>
</td>
</tr>
<tr id="DeleteRelease__row568018327248"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p13682153212410">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p1968293213245">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p4682173272413">Release status.</p>
<ul id="DeleteRelease__ul136821432132413"><li id="DeleteRelease__li1268213326241"><strong id="DeleteRelease__b166821732172417">DEPLOYED</strong>: The release is normal.</li><li id="DeleteRelease__li5682193242415"><strong id="DeleteRelease__b0682203272413">DELETED</strong>: The release has been deleted.</li><li id="DeleteRelease__li168263216241"><strong id="DeleteRelease__b46821932152414">FAILED</strong>: The release fails to be deployed.</li><li id="DeleteRelease__li7683103252419"><strong id="DeleteRelease__b11683163217243">DELETING</strong>: The release is being deleted.</li><li id="DeleteRelease__li768315329241"><strong id="DeleteRelease__b1568315325243">PENDING_INSTALL</strong>: The release is waiting to be installed.</li><li id="DeleteRelease__li768333219245"><strong id="DeleteRelease__b168315323240">PENDING_UPGRADE</strong>: The release is waiting to be upgraded.</li><li id="DeleteRelease__li16683133211247"><strong id="DeleteRelease__b76834327247">PENDING_ROLLBACK</strong>: The release is waiting for rollback.</li><li id="DeleteRelease__li156834327243"><strong id="DeleteRelease__b10683153282418">UNKNOWN</strong>: The release status is unknown, indicating that the release is abnormal. You can manually delete the release and reinstall it.</li></ul>
</td>
</tr>
<tr id="DeleteRelease__row13680153212244"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p068317321243">status_description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p168373212241">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p768313220248">Release status description</p>
</td>
</tr>
<tr id="DeleteRelease__row156801932142414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p1168303213240">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p1768343242413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p11683173282412">Updated at</p>
</td>
</tr>
<tr id="DeleteRelease__row13680173282418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p14683153222410">values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p1568313282412">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p12683103215249">Release value</p>
</td>
</tr>
<tr id="DeleteRelease__row16680103216247"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteRelease__p1368313212241">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteRelease__p868323212413">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteRelease__p1368373252410">Release version</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteRelease__section10752174518552"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteRelease__p127523459555">None</p>
</div>
<div class="section" id="DeleteRelease__section47531845195512"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteRelease__p1868323262411"><strong id="DeleteRelease__b1683432152412">Status code: 200</strong></p>
<p id="DeleteRelease__p166839323243">OK</p>
<pre class="screen" id="DeleteRelease__screen1568353232415">{
"chart_name" : "magento-mysql",
"chart_public" : false,
"chart_version" : "1.0.0",
"cluster_id" : "a870253f-5dc7-11ee-bf71-0255ac100b03",
"cluster_name" : "sfs-turbo-test",
"create_at" : "2023-11-14T20:30:57+08:00",
"name" : "testwww",
"namespace" : "monitoring",
"parameters" : "",
"resources" : "",
"status" : "DELETING",
"update_at" : "2023-11-14T20:30:57+08:00",
"values" : "{\"basic\":{\"admin_password\":\"******\",\"admin_username\":\"username\",\"app_name\":\"magento\",\"mysql_database\":\"magento\",\"mysql_name\":\"mysql\",\"mysql_password\":\"******\",\"mysql_port\":3306,\"mysql_root_password\":\"******\",\"mysql_user\":\"magento\",\"storage_class\":\"csi-nas\",\"storage_mode\":\"ReadWriteMany\",\"storage_size\":\"10G\"},\"global\":{\"magento_EIP\":\"100.100.100.100\",\"magento_EPORT\":32080,\"namespace\":\"default\"},\"image\":{\"magento_image\":\"example.com/everest/magento:latest\",\"mysql_image\":\"example.com/everest/mysql:5.7.14\"}}",
"version" : 1
}</pre>
</div>
<div class="section" id="DeleteRelease__section177531645115516"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteRelease__en-us_topic_0000001896008885_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteRelease__row16754184517559"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteRelease__p77541945175517">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteRelease__p15755164555511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteRelease__row1975454515510"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteRelease__p11755144514556">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteRelease__p15756645175512">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteRelease__section67561453559"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteRelease__p16756045175517">See <a href="cce_02_0250.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="chart_lifecycle_management.html">Chart Management</a></div>
</div>
</div>