yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
52a58dcf0666c9276f7255b3cb3d2ca3866152f8
doc-exports/docs/cce/api-ref/ShowRelease.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

264 lines
19 KiB
HTML
Raw Blame History

<a name="ShowRelease"></a><a name="ShowRelease"></a>
<h1 class="topictitle1">Obtaining a Release</h1>
<div id="body32001227"><div class="section" id="ShowRelease__section34890115577"><h4 class="sectiontitle">Function</h4><p id="ShowRelease__p1748991175713">This API is used to obtain a release.</p>
</div>
<div class="section" id="ShowRelease__en-us_topic_0000001896008929_atuogenerate_1"><h4 class="sectiontitle">URI</h4><p id="ShowRelease__p34895116576">GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowRelease__table84981511195717" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowRelease__row1497101111574"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowRelease__p1949961110577">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowRelease__p7499161115714">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowRelease__p1949914114574">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowRelease__p185008111574">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowRelease__row194971411145715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowRelease__p1350551175713">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowRelease__p3506191119577">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowRelease__p2506311105714">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowRelease__p650615111575">Release name</p>
</td>
</tr>
<tr id="ShowRelease__row1849821112572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowRelease__p35071411105718">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowRelease__p135071111105717">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowRelease__p125081811165711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowRelease__p2508911105713">Namespace of the chart</p>
</td>
</tr>
<tr id="ShowRelease__row2498181110578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowRelease__p85092011115717">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowRelease__p4509141165711">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowRelease__p15510511185714">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowRelease__p175105112579">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="ShowRelease__section18514191125714"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowRelease__en-us_topic_0000001896008929_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ShowRelease__row351471111572"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowRelease__p7515511115714">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowRelease__p851631185718">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowRelease__p205165116578">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowRelease__p19516111115719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowRelease__row1451541113572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowRelease__p1151771114579">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowRelease__p35178110575">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowRelease__p105172117575">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowRelease__p175132048141618">Details:</p>
<p id="ShowRelease__p1513184851611">Request body type or format.</p>
<p id="ShowRelease__p363312163118">Constraints:</p>
<p id="ShowRelease__p86331116121112">The GET method is not verified.</p>
<p id="ShowRelease__p36336166115">Options:</p>
<ul id="ShowRelease__ul166331116111111"><li id="ShowRelease__li6633516101110">application/json</li><li id="ShowRelease__li1363351614116">application/json;charset=utf-8</li><li id="ShowRelease__li0633191617110">application/x-pem-file</li><li id="ShowRelease__li192591549143012">multipart/form-data (It can be used when the <strong id="ShowRelease__uploadchart_b1058912225107">FormData</strong> parameter exists.)</li></ul>
<p id="ShowRelease__p363331671112">Default value:</p>
<p id="ShowRelease__p5633151617112">N/A</p>
</td>
</tr>
<tr id="ShowRelease__row1851517117578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowRelease__p155181611185713">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowRelease__p175181611165712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowRelease__p45181411195717">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowRelease__p1951910118570">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="ShowRelease__section1951971155717"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowRelease__p9520151113576"><strong id="ShowRelease__b15520121110579">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowRelease__en-us_topic_0000001896008929_response_ReleaseResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowRelease__row10520711185718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowRelease__p11523171115575">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowRelease__p1652320115576">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowRelease__p25246110572">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowRelease__row752111125713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p1352461119575">chart_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p1252491175712">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p052520116576">Chart name</p>
</td>
</tr>
<tr id="ShowRelease__row1521811125712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p13525211195719">chart_public</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p2052551110575">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p252601115715">Whether the chart is public</p>
</td>
</tr>
<tr id="ShowRelease__row65211511185717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p9526311205714">chart_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p252681155712">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p552661117574">Chart version</p>
</td>
</tr>
<tr id="ShowRelease__row185211511165713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p125274113575">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p1152711114578">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p1552791117576">Cluster ID</p>
</td>
</tr>
<tr id="ShowRelease__row9521311155712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p14528131118577">cluster_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p75282119575">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p4528611105719">Current name</p>
</td>
</tr>
<tr id="ShowRelease__row6521711125713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p252911112574">create_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p152921110572">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p452931110572">Created at</p>
</td>
</tr>
<tr id="ShowRelease__row1352151114575"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p1953015111578">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p1253011114573">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p95301311125713">Release description</p>
</td>
</tr>
<tr id="ShowRelease__row145218119570"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p16531411185714">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p155317111579">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p1253114112575">Release name</p>
</td>
</tr>
<tr id="ShowRelease__row1252121110572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p8532811195719">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p453218117576">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p1053381117572">Namespace to which a chart release belongs</p>
</td>
</tr>
<tr id="ShowRelease__row15522161111575"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p45331211145713">parameters</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p753316113574">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p353461145714">Release parameters</p>
</td>
</tr>
<tr id="ShowRelease__row65220113578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p9534811115711">resources</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p1253411114579">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p4535181175717">Resources required by the release</p>
</td>
</tr>
<tr id="ShowRelease__row19522191117576"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p1653519116570">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p953561175716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p153618119572">Release status</p>
<ul id="ShowRelease__ul494018320242"><li id="ShowRelease__li4940103222411"><strong id="ShowRelease__b79401232192416">DEPLOYED</strong>: The release is normal.</li><li id="ShowRelease__li1094023282413"><strong id="ShowRelease__b15940832102416">DELETED</strong>: The release has been deleted.</li><li id="ShowRelease__li194012323241"><strong id="ShowRelease__b17940163217241">FAILED</strong>: The release fails to be deployed.</li><li id="ShowRelease__li119401432152417"><strong id="ShowRelease__b9940163252418">DELETING</strong>: The release is being deleted.</li><li id="ShowRelease__li59401932122410"><strong id="ShowRelease__b6940132182420">PENDING_INSTALL</strong>: The release is waiting to be installed.</li><li id="ShowRelease__li99404321247"><strong id="ShowRelease__b119401232172417">PENDING_UPGRADE</strong>: The release is waiting to be upgraded.</li><li id="ShowRelease__li794093262419"><strong id="ShowRelease__b1194018328242">PENDING_ROLLBACK</strong>: The release is waiting for rollback.</li><li id="ShowRelease__li13940163217248"><strong id="ShowRelease__b189405326246">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="ShowRelease__row155221119574"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p15361011135714">status_description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p175371511175715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p953751145719">Release status description</p>
</td>
</tr>
<tr id="ShowRelease__row16522131112572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p2053761119571">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p195381811135713">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p1153871115710">Updated at</p>
</td>
</tr>
<tr id="ShowRelease__row1752219116576"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p19538161135720">values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p195391211125710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p85397113571">Release value</p>
</td>
</tr>
<tr id="ShowRelease__row85222011195711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowRelease__p3539111185711">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowRelease__p5540511205710">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowRelease__p155403114578">Release version</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowRelease__section5541191114578"><h4 class="sectiontitle">Example Requests</h4><p id="ShowRelease__p135412116572">None</p>
</div>
<div class="section" id="ShowRelease__section14541181175715"><h4 class="sectiontitle">Example Responses</h4><p id="ShowRelease__p1754111145717"><strong id="ShowRelease__b754251155720">Status code: 200</strong></p>
<p id="ShowRelease__p16542711135716">OK</p>
<pre class="screen" id="ShowRelease__screen195436113573">{
"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",
"description" : "Initial install underway",
"name" : "testwww",
"namespace" : "monitoring",
"parameters" : "",
"resources" : "",
"status" : "PENDING_INSTALL",
"status_description" : "Initial install underway",
"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="ShowRelease__section1254661165718"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowRelease__en-us_topic_0000001896008929_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowRelease__row65466117573"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowRelease__p454714111571">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowRelease__p35478119570">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowRelease__row9547121113570"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowRelease__p14548811175720">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowRelease__p1054814114571">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowRelease__section55491911145718"><h4 class="sectiontitle">Error Codes</h4><p id="ShowRelease__p1554911110576">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>
View Git Blame Copy Permalink