vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/cce/api-ref/cce_02_0326.html
Dong, Qiu Jian 3336ba8df7 CCE API for v1.23 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
2022-11-10 12:48:59 +00:00

507 lines
35 KiB
HTML
Raw Blame History

<a name="cce_02_0326"></a><a name="cce_02_0326"></a>
<h1 class="topictitle1">Listing Add-on Instances</h1>
<div id="body1595231617777"><div class="section" id="cce_02_0326__section108927501774"><h4 class="sectiontitle">Function</h4><p id="cce_02_0326__p38937501177">This API is used to list all add-on instances in the cluster.</p>
<div class="note" id="cce_02_0326__note42209401757"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cce_02_0326__p8220640955">The URL for add-on management is in the format of <strong id="cce_02_0326__b598718254523">https://{clusterid}.Endpoint/uri.</strong> In the URL, <em id="cce_02_0326__i1485018501457">{clusterid}</em> indicates the cluster ID, and <em id="cce_02_0326__i198501050458">uri</em> indicates the resource path, that is, the path for API access.</p>
</div></div>
</div>
<div class="section" id="cce_02_0326__section68937501179"><h4 class="sectiontitle">URI</h4><p id="cce_02_0326__p689415501172">GET /api/v3/addons?cluster_id={cluster_id}</p>
<p id="cce_02_0326__p196718391439"><a href="#cce_02_0326__table489613501374">Table 1</a> describes the parameters of this API.</p>
<div class="tablenoborder"><a name="cce_02_0326__table489613501374"></a><a name="table489613501374"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0326__table489613501374" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="cce_02_0326__row198955507711"><th align="left" class="cellrowborder" valign="top" width="16.509999999999998%" id="mcps1.3.2.4.2.5.1.1"><p id="cce_02_0326__p289718501577">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.16%" id="mcps1.3.2.4.2.5.1.2"><p id="cce_02_0326__p629412918011">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.380000000000003%" id="mcps1.3.2.4.2.5.1.3"><p id="cce_02_0326__p1489725017716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.949999999999996%" id="mcps1.3.2.4.2.5.1.4"><p id="cce_02_0326__p4898185014715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0326__row108951650475"><td class="cellrowborder" valign="top" width="16.509999999999998%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0326__p1389812506713">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.16%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0326__p82942910016">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.380000000000003%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0326__p1789915507711">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.949999999999996%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0326__p15106445114416">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>
<div class="section" id="cce_02_0326__section89068508720"><h4 class="sectiontitle">Request Parameters</h4><p id="cce_02_0326__p1759612252385"><strong id="cce_02_0326__b22258491666">Request parameters:</strong></p>
<p id="cce_02_0326__p1593418292381"><a href="#cce_02_0326__table52418212211">Table 2</a> lists the request parameters.</p>
<div class="tablenoborder"><a name="cce_02_0326__table52418212211"></a><a name="table52418212211"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0326__table52418212211" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="cce_02_0326__cce_02_0236_row55001954122614"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.4.1.1"><p id="cce_02_0326__cce_02_0236_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_0326__cce_02_0236_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_0326__cce_02_0236_p16500154162611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0326__cce_02_0236_row199801811203412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0326__cce_02_0236_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_0326__cce_02_0236_p3980111103414">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.4.1.3 "><p id="cce_02_0326__cce_02_0236_p169801011203416">Message body type (format). Possible values:</p>
<ul id="cce_02_0326__cce_02_0236_ul7385444163617"><li id="cce_02_0326__cce_02_0236_li18385114483612">application/json;charset=utf-8</li><li id="cce_02_0326__cce_02_0236_li3516132853714">application/json</li></ul>
</td>
</tr>
<tr id="cce_02_0326__cce_02_0236_row3500125412260"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0326__cce_02_0236_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_0326__cce_02_0236_p20500954182618">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.4.1.3 "><p id="cce_02_0326__p1355117221012">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_0344.html">API Usage Guidelines</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cce_02_0326__p717664610382"><strong id="cce_02_0326__b127331931175">Example request:</strong></p>
<p id="cce_02_0326__p452405014387">N/A</p>
</div>
<div class="section" id="cce_02_0326__section691935020713"><h4 class="sectiontitle">Response</h4><p id="cce_02_0326__p1093112411394"><strong id="cce_02_0326__b35461961711">Response parameters:</strong></p>
<p id="cce_02_0326__p1290610518398">For details about the response parameters, see <a href="#cce_02_0326__responseParameter">Table 3</a>.</p>
<div class="tablenoborder"><a name="cce_02_0326__responseParameter"></a><a name="responseParameter"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0326__responseParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response body</caption><thead align="left"><tr id="cce_02_0326__row392414502719"><th align="left" class="cellrowborder" valign="top" width="23.907609239076095%" id="mcps1.3.4.4.2.4.1.1"><p id="cce_02_0326__p1992816501972">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.4.4.2.4.1.2"><p id="cce_02_0326__p09289506713">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.76402359764024%" id="mcps1.3.4.4.2.4.1.3"><p id="cce_02_0326__p092910501876">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0326__row3924185012719"><td class="cellrowborder" valign="top" width="23.907609239076095%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0326__p1692919501377">kind</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0326__p1793014504716">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.76402359764024%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0326__p109308501873">API type. The value is fixed at <strong id="cce_02_0326__b13777181619913">Addon</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="cce_02_0326__row139243501972"><td class="cellrowborder" valign="top" width="23.907609239076095%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0326__p993110507710">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0326__p6931185016711">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.76402359764024%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0326__p493319504719">API version. The value is fixed at <strong id="cce_02_0326__b178056198913">v3</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="cce_02_0326__row139252050570"><td class="cellrowborder" valign="top" width="23.907609239076095%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0326__p293315501374">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0326__p199345504710">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.76402359764024%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0326__p16935135010714">Basic information about the add-on. Metadata is a collection of attributes.</p>
</td>
</tr>
<tr id="cce_02_0326__row892595010713"><td class="cellrowborder" valign="top" width="23.907609239076095%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0326__p109382509720">items</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0326__p4938350474">Array of <a href="#cce_02_0326__response_addoninstance">items</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="59.76402359764024%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0326__p1593918501575">Add-on instance list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0326__response_addoninstance"></a><a name="response_addoninstance"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0326__response_addoninstance" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Data structure of the items field</caption><thead align="left"><tr id="cce_02_0326__row169413501271"><th align="left" class="cellrowborder" valign="top" width="20.849999999999998%" id="mcps1.3.4.5.2.4.1.1"><p id="cce_02_0326__p894314505715">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.64%" id="mcps1.3.4.5.2.4.1.2"><p id="cce_02_0326__p1594410501672">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.51%" id="mcps1.3.4.5.2.4.1.3"><p id="cce_02_0326__p79451050773">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0326__row79411850572"><td class="cellrowborder" valign="top" width="20.849999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0326__p794612501372">kind</p>
</td>
<td class="cellrowborder" valign="top" width="20.64%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0326__p139472503714">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.51%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0326__p109481350971">API type. The value is fixed at <strong id="cce_02_0326__b17815446912">Addon</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="cce_02_0326__row18942125015719"><td class="cellrowborder" valign="top" width="20.849999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0326__p179489503713">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20.64%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0326__p1994910501272">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.51%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0326__p189503505717">API version. The value is fixed at <strong id="cce_02_0326__b1127646299">v3</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="cce_02_0326__row139424501712"><td class="cellrowborder" valign="top" width="20.849999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0326__p195011501173">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20.64%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0326__p1295111501278"><a href="#cce_02_0326__response_metadata">metadata</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="58.51%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0326__p129542504720">Basic information about the add-on. Metadata is a collection of attributes.</p>
</td>
</tr>
<tr id="cce_02_0326__row14942650077"><td class="cellrowborder" valign="top" width="20.849999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0326__p16955145011712">spec</p>
</td>
<td class="cellrowborder" valign="top" width="20.64%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0326__p1495665020710"><a href="#cce_02_0326__response_instanceSpec">spec</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="58.51%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0326__p7958650573">Detailed description of the add-on instance.</p>
</td>
</tr>
<tr id="cce_02_0326__row894219508714"><td class="cellrowborder" valign="top" width="20.849999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0326__p69597507715">status</p>
</td>
<td class="cellrowborder" valign="top" width="20.64%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0326__p29609508716"><a href="#cce_02_0326__response_status">status</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="58.51%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0326__p1296317501873">Add-on instance status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0326__response_metadata"></a><a name="response_metadata"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0326__response_metadata" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Data structure of the metadata field</caption><thead align="left"><tr id="cce_02_0326__row107017516717"><th align="left" class="cellrowborder" valign="top" width="21.17%" id="mcps1.3.4.6.2.4.1.1"><p id="cce_02_0326__p1751851877">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.82%" id="mcps1.3.4.6.2.4.1.2"><p id="cce_02_0326__p975165119719">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.01%" id="mcps1.3.4.6.2.4.1.3"><p id="cce_02_0326__p1178105116711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0326__row107135111717"><td class="cellrowborder" valign="top" width="21.17%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0326__p18794519717">uid</p>
</td>
<td class="cellrowborder" valign="top" width="20.82%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0326__p128011518712">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.01%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0326__p2081165117710">Unique ID of the add-on instance.</p>
</td>
</tr>
<tr id="cce_02_0326__row20712511171"><td class="cellrowborder" valign="top" width="21.17%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0326__p1668510511377">name</p>
</td>
<td class="cellrowborder" valign="top" width="20.82%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0326__p86856511373">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.01%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0326__p1568545119720">Add-on name.</p>
</td>
</tr>
<tr id="cce_02_0326__row127119514717"><td class="cellrowborder" valign="top" width="21.17%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0326__p668519519713">labels</p>
</td>
<td class="cellrowborder" valign="top" width="20.82%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0326__p674151342713">Object</p>
</td>
<td class="cellrowborder" valign="top" width="58.01%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0326__p268617512718">Add-on labels in the format of key-value pairs.</p>
</td>
</tr>
<tr id="cce_02_0326__row8727511675"><td class="cellrowborder" valign="top" width="21.17%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0326__p106861651975">annotations</p>
</td>
<td class="cellrowborder" valign="top" width="20.82%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0326__p176861151678">Object</p>
</td>
<td class="cellrowborder" valign="top" width="58.01%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0326__p1168665111711">Add-on annotations in the format of key-value pairs.</p>
</td>
</tr>
<tr id="cce_02_0326__row1972135120712"><td class="cellrowborder" valign="top" width="21.17%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0326__p4686551974">updateTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20.82%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0326__p66869516716">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.01%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0326__p1568635112719">Time when the add-on instance was updated.</p>
</td>
</tr>
<tr id="cce_02_0326__row10728511678"><td class="cellrowborder" valign="top" width="21.17%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0326__p368711518711">creationTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20.82%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0326__p768715116714">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.01%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0326__p15687135118719">Time when the add-on instance was created.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0326__response_instanceSpec"></a><a name="response_instanceSpec"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0326__response_instanceSpec" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Data structure of the spec field</caption><thead align="left"><tr id="cce_02_0326__row74125116711"><th align="left" class="cellrowborder" valign="top" width="22.93%" id="mcps1.3.4.7.2.4.1.1"><p id="cce_02_0326__p54617513717">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.75%" id="mcps1.3.4.7.2.4.1.2"><p id="cce_02_0326__p647185120710">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.32000000000001%" id="mcps1.3.4.7.2.4.1.3"><p id="cce_02_0326__p34955113718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0326__row13422511472"><td class="cellrowborder" valign="top" width="22.93%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0326__p7501511779">clusterID</p>
</td>
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0326__p55015118712">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0326__p15516511713">Cluster ID.</p>
</td>
</tr>
<tr id="cce_02_0326__row10423511072"><td class="cellrowborder" valign="top" width="22.93%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0326__p11520515717">version</p>
</td>
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0326__p253135115717">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0326__p125435114714">Add-on template version, for example, v1.0.0.</p>
</td>
</tr>
<tr id="cce_02_0326__row742251170"><td class="cellrowborder" valign="top" width="22.93%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0326__p35575112718">addonTemplateName</p>
</td>
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0326__p1056125118713">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0326__p125710514710">Add-on template name, for example, coredns.</p>
</td>
</tr>
<tr id="cce_02_0326__row1042185111710"><td class="cellrowborder" valign="top" width="22.93%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0326__p558155112717">addonTemplateType</p>
</td>
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0326__p4591751379">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0326__p660951672">Add-on template type.</p>
</td>
</tr>
<tr id="cce_02_0326__row2043195114710"><td class="cellrowborder" valign="top" width="22.93%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0326__p86117511174">addonTemplateLabels</p>
</td>
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0326__p962651371">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0326__p663451374">Group to which the add-on template belongs.</p>
</td>
</tr>
<tr id="cce_02_0326__row4431051477"><td class="cellrowborder" valign="top" width="22.93%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0326__p96435116719">description</p>
</td>
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0326__p765551677">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0326__p206695110714">Add-on template description.</p>
</td>
</tr>
<tr id="cce_02_0326__row5449511979"><td class="cellrowborder" valign="top" width="22.93%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0326__p11663518714">values</p>
</td>
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0326__p166714514718">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.32000000000001%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0326__p18685511374">Add-on template installation parameters. These parameters vary with add-on.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0326__response_status"></a><a name="response_status"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0326__response_status" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Data structure of the status field</caption><thead align="left"><tr id="cce_02_0326__row1496719506712"><th align="left" class="cellrowborder" valign="top" width="23.65%" id="mcps1.3.4.8.2.4.1.1"><p id="cce_02_0326__p69711850179">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.23%" id="mcps1.3.4.8.2.4.1.2"><p id="cce_02_0326__p6972145015718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.12%" id="mcps1.3.4.8.2.4.1.3"><p id="cce_02_0326__p1397325019718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0326__row496720500713"><td class="cellrowborder" valign="top" width="23.65%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0326__p99741750479">status</p>
</td>
<td class="cellrowborder" valign="top" width="17.23%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0326__p1197505019718">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.12%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0326__p19778501676">Add-on instance status.</p>
</td>
</tr>
<tr id="cce_02_0326__row149679501871"><td class="cellrowborder" valign="top" width="23.65%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0326__p15978450279">Reason</p>
</td>
<td class="cellrowborder" valign="top" width="17.23%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0326__p119785502077">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.12%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0326__p09794501176">Cause why the system failed to list add-on instances.</p>
</td>
</tr>
<tr id="cce_02_0326__row199684501470"><td class="cellrowborder" valign="top" width="23.65%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0326__p99809501072">message</p>
</td>
<td class="cellrowborder" valign="top" width="17.23%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0326__p8981250176">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.12%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0326__p129831501471">Details about the error that occurred when listing add-on instances.</p>
</td>
</tr>
<tr id="cce_02_0326__row99683501876"><td class="cellrowborder" valign="top" width="23.65%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0326__p998413501977">targetVersions</p>
</td>
<td class="cellrowborder" valign="top" width="17.23%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0326__p12985150273">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="59.12%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0326__p29877502710">Versions to which the current add-on version can be upgraded.</p>
</td>
</tr>
<tr id="cce_02_0326__row896835010719"><td class="cellrowborder" valign="top" width="23.65%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0326__p498785016717">currentVersion</p>
</td>
<td class="cellrowborder" valign="top" width="17.23%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0326__p189886501570"><a href="#cce_02_0326__response_versions">versions</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="59.12%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0326__p4990135016715">Current add-on version.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0326__response_versions"></a><a name="response_versions"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0326__response_versions" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Data structure of the versions field</caption><thead align="left"><tr id="cce_02_0326__row199931450577"><th align="left" class="cellrowborder" valign="top" width="23.419999999999998%" id="mcps1.3.4.9.2.4.1.1"><p id="cce_02_0326__p109972501473">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.029999999999998%" id="mcps1.3.4.9.2.4.1.2"><p id="cce_02_0326__p159985509718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.550000000000004%" id="mcps1.3.4.9.2.4.1.3"><p id="cce_02_0326__p101195114718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0326__row1899317501677"><td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.4.9.2.4.1.1 "><p id="cce_02_0326__p0285116716">version</p>
</td>
<td class="cellrowborder" valign="top" width="18.029999999999998%" headers="mcps1.3.4.9.2.4.1.2 "><p id="cce_02_0326__p131511270">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.550000000000004%" headers="mcps1.3.4.9.2.4.1.3 "><p id="cce_02_0326__p85125116717">Add-on version.</p>
</td>
</tr>
<tr id="cce_02_0326__row13993450777"><td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.4.9.2.4.1.1 "><p id="cce_02_0326__p19615514719">input</p>
</td>
<td class="cellrowborder" valign="top" width="18.029999999999998%" headers="mcps1.3.4.9.2.4.1.2 "><p id="cce_02_0326__p1677512070">Object</p>
</td>
<td class="cellrowborder" valign="top" width="58.550000000000004%" headers="mcps1.3.4.9.2.4.1.3 "><p id="cce_02_0326__p39115120710">Add-on installation parameters.</p>
</td>
</tr>
<tr id="cce_02_0326__row129932050276"><td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.4.9.2.4.1.1 "><p id="cce_02_0326__p71012512711">stable</p>
</td>
<td class="cellrowborder" valign="top" width="18.029999999999998%" headers="mcps1.3.4.9.2.4.1.2 "><p id="cce_02_0326__p1611451177">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="58.550000000000004%" headers="mcps1.3.4.9.2.4.1.3 "><p id="cce_02_0326__p71310511711">Indicates whether the add-on version is a stable release.</p>
</td>
</tr>
<tr id="cce_02_0326__row15994250971"><td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.4.9.2.4.1.1 "><p id="cce_02_0326__p17143511479">translate</p>
</td>
<td class="cellrowborder" valign="top" width="18.029999999999998%" headers="mcps1.3.4.9.2.4.1.2 "><p id="cce_02_0326__p131585111714">Object</p>
</td>
<td class="cellrowborder" valign="top" width="58.550000000000004%" headers="mcps1.3.4.9.2.4.1.3 "><p id="cce_02_0326__p14173511779">Translation information used by the GUI.</p>
</td>
</tr>
<tr id="cce_02_0326__row4994135020715"><td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.4.9.2.4.1.1 "><p id="cce_02_0326__p41819511710">supportVersions</p>
</td>
<td class="cellrowborder" valign="top" width="18.029999999999998%" headers="mcps1.3.4.9.2.4.1.2 "><p id="cce_02_0326__p41835112715">Array of <a href="#cce_02_0326__response_supportVersions">supportVersions</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="58.550000000000004%" headers="mcps1.3.4.9.2.4.1.3 "><p id="cce_02_0326__p62019518712">Cluster versions that support the add-on.</p>
<div class="note" id="cce_02_0326__note0702131124412"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="cce_02_0326__p77026184417">This field is not supported for the current version.</p>
</div></div>
</td>
</tr>
<tr id="cce_02_0326__row99941250170"><td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.4.9.2.4.1.1 "><p id="cce_02_0326__p921651074">creationTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="18.029999999999998%" headers="mcps1.3.4.9.2.4.1.2 "><p id="cce_02_0326__p822115112715">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.550000000000004%" headers="mcps1.3.4.9.2.4.1.3 "><p id="cce_02_0326__p172316512713">Time when the add-on instance was created.</p>
</td>
</tr>
<tr id="cce_02_0326__row189953501573"><td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.4.9.2.4.1.1 "><p id="cce_02_0326__p18242511270">updateTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="18.029999999999998%" headers="mcps1.3.4.9.2.4.1.2 "><p id="cce_02_0326__p62415110712">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.550000000000004%" headers="mcps1.3.4.9.2.4.1.3 "><p id="cce_02_0326__p1926185116711">Time when the add-on instance was updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0326__response_supportVersions"></a><a name="response_supportVersions"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0326__response_supportVersions" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Data structure of the supportVersions field</caption><thead align="left"><tr id="cce_02_0326__row3278514710"><th align="left" class="cellrowborder" valign="top" width="23.392339233923394%" id="mcps1.3.4.10.2.4.1.1"><p id="cce_02_0326__p3312511379">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.12181218121812%" id="mcps1.3.4.10.2.4.1.2"><p id="cce_02_0326__p53235111720">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.48584858485848%" id="mcps1.3.4.10.2.4.1.3"><p id="cce_02_0326__p0331511274">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0326__row7281651376"><td class="cellrowborder" valign="top" width="23.392339233923394%" headers="mcps1.3.4.10.2.4.1.1 "><p id="cce_02_0326__p13416518713">clusterType</p>
</td>
<td class="cellrowborder" valign="top" width="18.12181218121812%" headers="mcps1.3.4.10.2.4.1.2 "><p id="cce_02_0326__p193412511720">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.48584858485848%" headers="mcps1.3.4.10.2.4.1.3 "><p id="cce_02_0326__p15368511674">Cluster type that supports the add-on.</p>
</td>
</tr>
<tr id="cce_02_0326__row9285519712"><td class="cellrowborder" valign="top" width="23.392339233923394%" headers="mcps1.3.4.10.2.4.1.1 "><p id="cce_02_0326__p103612510712">clusterVersion</p>
</td>
<td class="cellrowborder" valign="top" width="18.12181218121812%" headers="mcps1.3.4.10.2.4.1.2 "><p id="cce_02_0326__p83745111715">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="58.48584858485848%" headers="mcps1.3.4.10.2.4.1.3 "><p id="cce_02_0326__p11391151577">Cluster versions that support the add-on. The parameter value is a regular expression.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="p" id="cce_02_0326__p12107194323911"><strong id="cce_02_0326__b6861120383">Example response:</strong><pre class="screen" id="cce_02_0326__screen9519511078">{
"apiVersion": "v3",
"kind": "Addon",
"items": [
{
"metadata": {
"uid": "8ca259cc-553b-11e9-926f-0255ac101a31",
"name": "storage-driver",
"creationTimestamp": "2019-04-02T11:36:26Z",
"updateTimestamp": "2019-04-02T11:36:26Z"
},
"apiVersion": "v3",
"kind": "Addon",
"spec": {
"addonTemplateName": "storage-driver",
"addonTemplateLogo": "https://192.168.48.66/cce-addon-aw1hz2u/storage-driverlogo.svg",
"addonTemplateType": "helm",
"values": {
"flavor": {
"replicas": 1
},
"basic": {
"obs_url": "",
"swr_user": "swr_test",
"euleros_version": "2.2.5",
"addon_version": "1.0.10",
"platform": "linux-amd64",
"swr_addr": "10.125.6.246:20202"
},
"parameters": {}
},
"description": "A kubernetes FlexVolume Driver used to support cloud storage",
"addonTemplateLabels": [
"Storage"
],
"clusterID": "0c0e4a63-5539-11e9-95f7-0255ac10177e",
"version": "1.0.10"
},
"status": {
"message": "",
"Reason": "Install complete",
"currentVersion": {
"input": {
"basic": {
"obs_url": "",
"swr_user": "swr_test",
"euleros_version": "2.2.5",
"swr_addr": "10.125.6.246:20202"
},
"parameters": {}
},
"stable": true,
"creationTimestamp": "2019-03-29T13:45:37Z",
"version": "1.0.10",
"translate": {
"en_US": {
"addon": {
"changeLog": "The plug-in is upgraded to enhance the storage plug-in function.",
"description": "A kubernetes FlexVolume Driver used to support cloud storage"
}
},
"zh_CN": {
"addon": {
"changeLog": "",
"description": ""
}
}
},
"updateTimestamp": "2019-03-29T13:45:37Z"
},
"status": "running"
}
}
]
}</pre>
</div>
</div>
<div class="section" id="cce_02_0326__section3694185113715"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0326__en-us_topic_0079614900_table46761928" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Status codes</caption><thead align="left"><tr id="cce_02_0326__en-us_topic_0079614900_row33254664"><th align="left" class="cellrowborder" valign="top" width="19.96%" id="mcps1.3.5.2.2.3.1.1"><p id="cce_02_0326__p55616028205955">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="80.04%" id="mcps1.3.5.2.2.3.1.2"><p id="cce_02_0326__p8604418205955">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0326__row176274101210"><td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.5.2.2.3.1.1 "><p id="cce_02_0326__p46285101728">200</p>
</td>
<td class="cellrowborder" valign="top" width="80.04%" headers="mcps1.3.5.2.2.3.1.2 "><p id="cce_02_0326__p126288106215">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cce_02_0326__p347213715512">For the description 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_0320.html">Add-on Management</a></div>
</div>
</div>
View Git Blame Copy Permalink