lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/cce/api-ref/cce_02_0325.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

462 lines
32 KiB
HTML
Raw Blame History

<a name="cce_02_0325"></a><a name="cce_02_0325"></a>
<h1 class="topictitle1">Reading an Add-on Instance</h1>
<div id="body1595231617769"><div class="section" id="cce_02_0325__section132251505716"><h4 class="sectiontitle">Function</h4><p id="cce_02_0325__p14226850379">This API is used to obtain details about an add-on instance.</p>
<div class="note" id="cce_02_0325__note42209401757"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cce_02_0325__p8220640955">The URL for add-on management is in the format of <strong id="cce_02_0325__b598718254523">https://{clusterid}.Endpoint/uri.</strong> In the URL, <em id="cce_02_0325__i1485018501457">{clusterid}</em> indicates the cluster ID, and <em id="cce_02_0325__i198501050458">uri</em> indicates the resource path, that is, the path for API access.</p>
</div></div>
</div>
<div class="section" id="cce_02_0325__section1922614501578"><h4 class="sectiontitle">URI</h4><p id="cce_02_0325__p19226185010710">GET /api/v3/addons/{id}?cluster_id={cluster_id}</p>
<p id="cce_02_0325__p2074422813435"><a href="#cce_02_0325__table14230135012719">Table 1</a> describes the parameters of this API.</p>
<div class="tablenoborder"><a name="cce_02_0325__table14230135012719"></a><a name="table14230135012719"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0325__table14230135012719" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="cce_02_0325__row32281850277"><th align="left" class="cellrowborder" valign="top" width="17.57%" id="mcps1.3.2.4.2.5.1.1"><p id="cce_02_0325__p62314501171">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.1%" id="mcps1.3.2.4.2.5.1.2"><p id="cce_02_0325__p352391517110">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_0325__p1223195020719">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_0325__p12332501719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0325__row122920501870"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0325__p423465011714">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.1%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0325__p1820482641118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.380000000000003%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0325__p1223420501672">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.949999999999996%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0325__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>
<tr id="cce_02_0325__row1222914501074"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0325__p123619502072">id</p>
</td>
<td class="cellrowborder" valign="top" width="11.1%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0325__p720412614119">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.380000000000003%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0325__p172375508710">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.949999999999996%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0325__p1725145224216">Add-on instance ID. For details about how to obtain the ID, see <a href="#cce_02_0325__response_metadata">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cce_02_0325__section19239850779"><h4 class="sectiontitle">Request</h4><p id="cce_02_0325__p226412478366"><strong id="cce_02_0325__b96491012459">Request parameters:</strong></p>
<p id="cce_02_0325__p10397143113363"><a href="#cce_02_0325__table913035652115">Table 2</a> lists the request parameters.</p>
<div class="tablenoborder"><a name="cce_02_0325__table913035652115"></a><a name="table913035652115"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0325__table913035652115" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="cce_02_0325__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_0325__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_0325__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_0325__cce_02_0236_p16500154162611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0325__cce_02_0236_row199801811203412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0325__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_0325__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_0325__cce_02_0236_p169801011203416">Message body type (format).</p>
<p id="cce_02_0325__p10511125693019">Default: <strong id="cce_02_0325__b47397406315">application/json</strong></p>
</td>
</tr>
<tr id="cce_02_0325__cce_02_0236_row3500125412260"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0325__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_0325__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_0325__p6469145216919">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_0325__p133365585367"><strong id="cce_02_0325__b146641715515">Example request:</strong></p>
<p id="cce_02_0325__p1937210533719">N/A</p>
</div>
<div class="section" id="cce_02_0325__section122556506719"><h4 class="sectiontitle">Response</h4><p id="cce_02_0325__p2319103643713"><strong id="cce_02_0325__b16197172016513">Response parameters:</strong></p>
<p id="cce_02_0325__p56181317163712">For details about the response parameters, see <a href="#cce_02_0325__responseParameter">Table 3</a>.</p>
<div class="tablenoborder"><a name="cce_02_0325__responseParameter"></a><a name="responseParameter"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0325__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_0325__row0259125011720"><th align="left" class="cellrowborder" valign="top" width="23.93%" id="mcps1.3.4.4.2.4.1.1"><p id="cce_02_0325__p426215506713">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.259999999999998%" id="mcps1.3.4.4.2.4.1.2"><p id="cce_02_0325__p726213501471">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.809999999999995%" id="mcps1.3.4.4.2.4.1.3"><p id="cce_02_0325__p42645501477">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0325__row0259135019711"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0325__p172655503712">kind</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0325__p926565018713">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.809999999999995%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0325__p1726635017718">API type. The value is fixed at <strong id="cce_02_0325__b18693118706">Addon</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="cce_02_0325__row1625995016717"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0325__p426725015717">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0325__p52680509711">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.809999999999995%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0325__p027013500719">API version. The value is fixed at <strong id="cce_02_0325__b144321723407">v3</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="cce_02_0325__row1026025017720"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0325__p52714507716">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0325__p52754501476"><a href="#cce_02_0325__response_metadata">metadata</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="59.809999999999995%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0325__p627813501175">Basic information about the add-on. Metadata is a collection of attributes.</p>
</td>
</tr>
<tr id="cce_02_0325__row32602050272"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0325__p152791950274">spec</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0325__p628112505716"><a href="#cce_02_0325__table17851616154117">spec</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="59.809999999999995%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0325__p1828316502711">Detailed description of the add-on instance.</p>
</td>
</tr>
<tr id="cce_02_0325__row926017506714"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0325__p928415016712">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0325__p72854508712"><a href="#cce_02_0325__response_status">status</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="59.809999999999995%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0325__p92889501379">Add-on instance status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0325__response_metadata"></a><a name="response_metadata"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0325__response_metadata" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Data structure of the metadata field</caption><thead align="left"><tr id="cce_02_0325__row19404650575"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.5.2.4.1.1"><p id="cce_02_0325__p114096509716">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.85%" id="mcps1.3.4.5.2.4.1.2"><p id="cce_02_0325__p1541010508718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.92%" id="mcps1.3.4.5.2.4.1.3"><p id="cce_02_0325__p1142019503720">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0325__row8405550878"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0325__p342113501718">uid</p>
</td>
<td class="cellrowborder" valign="top" width="24.85%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0325__p1842305015719">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.92%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0325__p842511501178">Unique ID of the add-on instance.</p>
</td>
</tr>
<tr id="cce_02_0325__row44056502074"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0325__p74271250076">name</p>
</td>
<td class="cellrowborder" valign="top" width="24.85%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0325__p17428195014719">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.92%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0325__p4429135012718">Add-on name.</p>
</td>
</tr>
<tr id="cce_02_0325__row1140513501672"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0325__p1642925016710">labels</p>
</td>
<td class="cellrowborder" valign="top" width="24.85%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0325__p365133313011">Object</p>
</td>
<td class="cellrowborder" valign="top" width="51.92%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0325__p114326501875">Add-on labels in the format of key-value pairs.</p>
</td>
</tr>
<tr id="cce_02_0325__row64069501975"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0325__p543313503716">annotations</p>
</td>
<td class="cellrowborder" valign="top" width="24.85%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0325__p152934360306">Object</p>
</td>
<td class="cellrowborder" valign="top" width="51.92%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0325__p174349501076">Add-on annotations in the format of key-value pairs.</p>
</td>
</tr>
<tr id="cce_02_0325__row5406850773"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0325__p13435195011715">updateTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="24.85%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0325__p643619501473">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.92%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0325__p24377505713">Time when the add-on instance was updated.</p>
</td>
</tr>
<tr id="cce_02_0325__row640611501171"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0325__p3438185017710">creationTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="24.85%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0325__p164380501714">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.92%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0325__p34703510718">Time when the add-on instance was created.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0325__table17851616154117"></a><a name="table17851616154117"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0325__table17851616154117" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Data structure of the spec field</caption><thead align="left"><tr id="cce_02_0325__row2934491475"><th align="left" class="cellrowborder" valign="top" width="20.76%" id="mcps1.3.4.6.2.4.1.1"><p id="cce_02_0325__p2097114915720">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.64%" id="mcps1.3.4.6.2.4.1.2"><p id="cce_02_0325__p5986491711">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.599999999999994%" id="mcps1.3.4.6.2.4.1.3"><p id="cce_02_0325__p69919492720">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0325__row893104917720"><td class="cellrowborder" valign="top" width="20.76%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0325__p9104114914710">clusterID</p>
</td>
<td class="cellrowborder" valign="top" width="22.64%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0325__p210512491779">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.599999999999994%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0325__p210719494712">Cluster ID.</p>
</td>
</tr>
<tr id="cce_02_0325__row6933491572"><td class="cellrowborder" valign="top" width="20.76%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0325__p111075491975">version</p>
</td>
<td class="cellrowborder" valign="top" width="22.64%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0325__p10108174914718">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.599999999999994%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0325__p210917491278">Add-on template version, for example, v1.0.0.</p>
</td>
</tr>
<tr id="cce_02_0325__row1194194911719"><td class="cellrowborder" valign="top" width="20.76%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0325__p141101149675">addonTemplateName</p>
</td>
<td class="cellrowborder" valign="top" width="22.64%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0325__p12110124910716">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.599999999999994%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0325__p17112144914711">Add-on template name, for example, coredns.</p>
</td>
</tr>
<tr id="cce_02_0325__row2944493716"><td class="cellrowborder" valign="top" width="20.76%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0325__p911324910719">addonTemplateType</p>
</td>
<td class="cellrowborder" valign="top" width="22.64%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0325__p15113154911719">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.599999999999994%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0325__p201151549179">Add-on template type.</p>
</td>
</tr>
<tr id="cce_02_0325__row6940499712"><td class="cellrowborder" valign="top" width="20.76%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0325__p81152493718">addonTemplateLabels</p>
</td>
<td class="cellrowborder" valign="top" width="22.64%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0325__p1711618491372">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="56.599999999999994%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0325__p2117174912717">Group to which the add-on template belongs.</p>
</td>
</tr>
<tr id="cce_02_0325__row129516491176"><td class="cellrowborder" valign="top" width="20.76%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0325__p81188499718">description</p>
</td>
<td class="cellrowborder" valign="top" width="22.64%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0325__p171217491179">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.599999999999994%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0325__p4122164918716">Add-on template description.</p>
</td>
</tr>
<tr id="cce_02_0325__row3951349875"><td class="cellrowborder" valign="top" width="20.76%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0325__p161222498716">values</p>
</td>
<td class="cellrowborder" valign="top" width="22.64%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0325__p15296727320">Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.599999999999994%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0325__p115348501975">Add-on template installation parameters. These parameters vary depending on the add-on.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0325__response_status"></a><a name="response_status"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0325__response_status" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Data structure of the status field</caption><thead align="left"><tr id="cce_02_0325__row1129110501475"><th align="left" class="cellrowborder" valign="top" width="19.54%" id="mcps1.3.4.7.2.4.1.1"><p id="cce_02_0325__p102992505716">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.99%" id="mcps1.3.4.7.2.4.1.2"><p id="cce_02_0325__p123017501973">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.47%" id="mcps1.3.4.7.2.4.1.3"><p id="cce_02_0325__p1930316508714">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0325__row129118501474"><td class="cellrowborder" valign="top" width="19.54%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0325__p530416501476">status</p>
</td>
<td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0325__p430519508715">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.47%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0325__p1330712505718">Add-on instance status.</p>
</td>
</tr>
<tr id="cce_02_0325__row829235015720"><td class="cellrowborder" valign="top" width="19.54%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0325__p18309950271">Reason</p>
</td>
<td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0325__p163108505710">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.47%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0325__p12312155018718">Cause why the system failed to read add-on instance details.</p>
</td>
</tr>
<tr id="cce_02_0325__row729219501574"><td class="cellrowborder" valign="top" width="19.54%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0325__p2313125015716">message</p>
</td>
<td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0325__p1831313504715">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.47%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0325__p15315125019719">Installation error details.</p>
</td>
</tr>
<tr id="cce_02_0325__row182939501710"><td class="cellrowborder" valign="top" width="19.54%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0325__p16315145010710">targetVersions</p>
</td>
<td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0325__p17316105012718">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="57.47%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0325__p93177501072">Versions to which the current add-on version can be upgraded.</p>
</td>
</tr>
<tr id="cce_02_0325__row129316507713"><td class="cellrowborder" valign="top" width="19.54%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0325__p831710501875">currentVersion</p>
</td>
<td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0325__p03187507711"><a href="#cce_02_0325__response_versions">versions</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="57.47%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0325__p183209501713">Current add-on version.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0325__response_versions"></a><a name="response_versions"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0325__response_versions" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Data structure of the versions field</caption><thead align="left"><tr id="cce_02_0325__row18322450879"><th align="left" class="cellrowborder" valign="top" width="23.25232523252325%" id="mcps1.3.4.8.2.4.1.1"><p id="cce_02_0325__p732825017710">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.48184818481848%" id="mcps1.3.4.8.2.4.1.2"><p id="cce_02_0325__p433014501575">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.26582658265826%" id="mcps1.3.4.8.2.4.1.3"><p id="cce_02_0325__p18332125015713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0325__row23231950379"><td class="cellrowborder" valign="top" width="23.25232523252325%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0325__p143321501279">version</p>
</td>
<td class="cellrowborder" valign="top" width="18.48184818481848%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0325__p933385018717">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.26582658265826%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0325__p2033525015714">Add-on version.</p>
</td>
</tr>
<tr id="cce_02_0325__row7323850473"><td class="cellrowborder" valign="top" width="23.25232523252325%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0325__p933505016710">input</p>
</td>
<td class="cellrowborder" valign="top" width="18.48184818481848%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0325__p123361150573">Object</p>
</td>
<td class="cellrowborder" valign="top" width="58.26582658265826%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0325__p1333712509712">Add-on installation parameters.</p>
</td>
</tr>
<tr id="cce_02_0325__row12323175016710"><td class="cellrowborder" valign="top" width="23.25232523252325%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0325__p193386501774">stable</p>
</td>
<td class="cellrowborder" valign="top" width="18.48184818481848%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0325__p10339115020718">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="58.26582658265826%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0325__p2340650674">Whether the add-on version is a stable release.</p>
</td>
</tr>
<tr id="cce_02_0325__row43241350975"><td class="cellrowborder" valign="top" width="23.25232523252325%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0325__p14340450772">translate</p>
</td>
<td class="cellrowborder" valign="top" width="18.48184818481848%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0325__p434118501272">Object</p>
</td>
<td class="cellrowborder" valign="top" width="58.26582658265826%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0325__p163456506714">Translation information used by the GUI.</p>
</td>
</tr>
<tr id="cce_02_0325__row6324145013719"><td class="cellrowborder" valign="top" width="23.25232523252325%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0325__p133452502071">supportVersions</p>
</td>
<td class="cellrowborder" valign="top" width="18.48184818481848%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0325__p1334645011719">Array of <a href="#cce_02_0325__response_supportVersions">supportVersions</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="58.26582658265826%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0325__p133471504715">Cluster versions that support the add-on.</p>
<div class="note" id="cce_02_0325__note0702131124412"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="cce_02_0325__p77026184417">This field is not supported for the current version.</p>
</div></div>
</td>
</tr>
<tr id="cce_02_0325__row732518503718"><td class="cellrowborder" valign="top" width="23.25232523252325%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0325__p1334875016713">creationTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="18.48184818481848%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0325__p734818501074">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.26582658265826%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0325__p193494506713">Time when the add-on instance was created.</p>
</td>
</tr>
<tr id="cce_02_0325__row17325750173"><td class="cellrowborder" valign="top" width="23.25232523252325%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0325__p535011501377">updateTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="18.48184818481848%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0325__p1735016505715">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.26582658265826%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0325__p1535285015716">Time when the add-on instance was updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0325__response_supportVersions"></a><a name="response_supportVersions"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0325__response_supportVersions" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Data structure of the supportVersions field</caption><thead align="left"><tr id="cce_02_0325__row1035415504718"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.9.2.4.1.1"><p id="cce_02_0325__p935645015710">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.5%" id="mcps1.3.4.9.2.4.1.2"><p id="cce_02_0325__p10357450274">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.49999999999999%" id="mcps1.3.4.9.2.4.1.3"><p id="cce_02_0325__p4358350274">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0325__row33544501779"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.9.2.4.1.1 "><p id="cce_02_0325__p133593505712">clusterType</p>
</td>
<td class="cellrowborder" valign="top" width="19.5%" headers="mcps1.3.4.9.2.4.1.2 "><p id="cce_02_0325__p43600501075">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.49999999999999%" headers="mcps1.3.4.9.2.4.1.3 "><p id="cce_02_0325__p1361450677">Cluster type that supports the add-on.</p>
</td>
</tr>
<tr id="cce_02_0325__row3354115011714"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.9.2.4.1.1 "><p id="cce_02_0325__p536217501774">clusterVersion</p>
</td>
<td class="cellrowborder" valign="top" width="19.5%" headers="mcps1.3.4.9.2.4.1.2 "><p id="cce_02_0325__p3363195019719">Array of string</p>
</td>
<td class="cellrowborder" valign="top" width="57.49999999999999%" headers="mcps1.3.4.9.2.4.1.3 "><p id="cce_02_0325__p103652508713">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_0325__p85010512372"><strong id="cce_02_0325__b314716311512">Example response:</strong><pre class="screen" id="cce_02_0325__screen1157404510369">{
"kind": "Addon",
"apiVersion": "v3",
"metadata": {
"uid": "24b23108-55c0-11e9-926f-0255ac101a31",
"name": "gpu-beta",
"creationTimestamp": "2019-04-03T03:25:34Z",
"updateTimestamp": "2019-04-03T03:25:34Z"
},
"apiVersion": "v3",
"kind": "Addon",
"spec": {
"addonTemplateName": "gpu-beta",
"addonTemplateLogo": "",
"addonTemplateType": "helm",
"values": {
"basic": {
"rbac_enabled": true,
"swr_user": "swr_test",
"swr_addr": "10.125.6.246:20202"
}
},
"description": "A device plugin for nvidia.com/gpu resource on nvidia driver",
"addonTemplateLabels": [
"Accelerator"
],
"clusterID": "0c0e4a63-5539-11e9-95f7-0255ac10177e",
"version": "1.0.0"
},
"status": {
"message": "",
"Reason": "",
"currentVersion": {
"input": {
"basic": {
"swr_user": "swr_test",
"swr_addr": "10.125.6.246:20202"
},
"parameters": {}
},
"stable": true,
"creationTimestamp": "2018-10-23T13:14:55Z",
"version": "1.0.0",
"translate": {
"en_US": {
"addon": {
"changeLog": "A device plugin for nvidia.com/gpu resource on nvidia driver",
"description": "A device plugin for nvidia.com/gpu resource on nvidia driver"
}
}
},
"updateTimestamp": "2018-12-07T09:40:24Z"
},
"status": "installing"
}
}</pre>
</div>
</div>
<div class="section" id="cce_02_0325__section14766511178"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0325__en-us_topic_0079614900_table46761928" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Status codes</caption><thead align="left"><tr id="cce_02_0325__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_0325__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_0325__p8604418205955">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0325__row176274101210"><td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.5.2.2.3.1.1 "><p id="cce_02_0325__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_0325__p126288106215">OK</p>
</td>
</tr>
<tr id="cce_02_0325__en-us_topic_0079614900_row41084259"><td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.5.2.2.3.1.1 "><p id="cce_02_0325__en-us_topic_0079614900_p39490674">500</p>
</td>
<td class="cellrowborder" valign="top" width="80.04%" headers="mcps1.3.5.2.2.3.1.2 "><p id="cce_02_0325__en-us_topic_0079614900_p44628050">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cce_02_0325__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