forked from docs/doc-exports
Dong, Qiu Jian
3336ba8df7
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>
543 lines
39 KiB
HTML
543 lines
39 KiB
HTML
<a name="cce_02_0321"></a><a name="cce_02_0321"></a>
|
|
|
|
<h1 class="topictitle1">Reading Add-on Templates</h1>
|
|
<div id="body1595231617740"><div class="section" id="cce_02_0321__section1534344818715"><h4 class="sectiontitle">Function</h4><p id="cce_02_0321__p1134420481776">This API is used to query add-on information.</p>
|
|
<div class="note" id="cce_02_0321__note42209401757"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cce_02_0321__p8220640955">The URL for add-on management is in the format of <strong id="cce_02_0321__b598718254523">https://{clusterid}.Endpoint/uri.</strong> In the URL, <em id="cce_02_0321__i1485018501457">{clusterid}</em> indicates the cluster ID, and <em id="cce_02_0321__i198501050458">uri</em> indicates the resource path, that is, the path for API access.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="cce_02_0321__section183455486713"><h4 class="sectiontitle">URI</h4><p id="cce_02_0321__p5346048373">GET /api/v3/addontemplates</p>
|
|
<p id="cce_02_0321__en-us_topic_0102499074_p54374860"><a href="#cce_02_0321__table737034819716">Table 1</a> describes the parameters of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0321__table737034819716"></a><a name="table737034819716"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0321__table737034819716" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="cce_02_0321__row103656481670"><th align="left" class="cellrowborder" valign="top" width="24.02240224022402%" id="mcps1.3.2.4.2.4.1.1"><p id="cce_02_0321__p133745480717">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.921592159215923%" id="mcps1.3.2.4.2.4.1.2"><p id="cce_02_0321__p616414954511">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60.056005600560056%" id="mcps1.3.2.4.2.4.1.3"><p id="cce_02_0321__p123801048676">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0321__row1836618488717"><td class="cellrowborder" valign="top" width="24.02240224022402%" headers="mcps1.3.2.4.2.4.1.1 "><p id="cce_02_0321__p1538114813711">addon_template_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.921592159215923%" headers="mcps1.3.2.4.2.4.1.2 "><p id="cce_02_0321__p4164991452">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.056005600560056%" headers="mcps1.3.2.4.2.4.1.3 "><p id="cce_02_0321__p207821128143017">Name of the specified template. If this parameter is left blank, all templates are queried.</p>
|
|
<p id="cce_02_0321__p16782152833013">Minimum: <strong id="cce_02_0321__b5996103443011">2</strong></p>
|
|
<p id="cce_02_0321__p18782102813300">Maximum: <strong id="cce_02_0321__b24536386308">30</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cce_02_0321__section93858481877"><a name="cce_02_0321__section93858481877"></a><a name="section93858481877"></a><h4 class="sectiontitle">Request</h4><p id="cce_02_0321__p204006201264"><strong id="cce_02_0321__b1948133163013">Request parameters:</strong></p>
|
|
<p id="cce_02_0321__p17484173282610"><a href="#cce_02_0321__table8687245142017">Table 2</a> lists the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0321__table8687245142017"></a><a name="table8687245142017"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0321__table8687245142017" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="cce_02_0321__cce_02_0236_row55001954122614"><th align="left" class="cellrowborder" valign="top" width="20.07%" id="mcps1.3.3.4.2.4.1.1"><p id="cce_02_0321__cce_02_0236_p115009545264">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.93%" id="mcps1.3.3.4.2.4.1.2"><p id="cce_02_0321__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_0321__cce_02_0236_p16500154162611">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0321__cce_02_0236_row199801811203412"><td class="cellrowborder" valign="top" width="20.07%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0321__cce_02_0236_p69808112344">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93%" headers="mcps1.3.3.4.2.4.1.2 "><p id="cce_02_0321__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_0321__cce_02_0236_p169801011203416">Message body type (format).</p>
|
|
<p id="cce_02_0321__p10511125693019">Default: <strong id="cce_02_0321__b47397406315">application/json</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__cce_02_0236_row3500125412260"><td class="cellrowborder" valign="top" width="20.07%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0321__cce_02_0236_p105001654202618">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93%" headers="mcps1.3.3.4.2.4.1.2 "><p id="cce_02_0321__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_0321__p121102231697">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>
|
|
<p id="cce_02_0321__p2896194914319">Maximum: <strong id="cce_02_0321__b18669195563113">16384</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0321__p15401856162712"><strong id="cce_02_0321__b1579019319012">Example request:</strong></p>
|
|
<p id="cce_02_0321__p13441520154716">NA</p>
|
|
</div>
|
|
<div class="section" id="cce_02_0321__section040116481479"><h4 class="sectiontitle">Response</h4><p id="cce_02_0321__p1415042114282">For details about the response parameters, see <a href="#cce_02_0321__responseParameter">Table 3</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0321__responseParameter"></a><a name="responseParameter"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0321__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_0321__row1340515482711"><th align="left" class="cellrowborder" valign="top" width="23.3023302330233%" id="mcps1.3.4.3.2.4.1.1"><p id="cce_02_0321__p11408174812712">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.43184318431843%" id="mcps1.3.4.3.2.4.1.2"><p id="cce_02_0321__p2040917481573">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.26582658265826%" id="mcps1.3.4.3.2.4.1.3"><p id="cce_02_0321__p1410184814714">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0321__row040511487711"><td class="cellrowborder" valign="top" width="23.3023302330233%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cce_02_0321__p241110481374">kind</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.43184318431843%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cce_02_0321__p5411144816717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.26582658265826%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cce_02_0321__p1841216488711">API type. The value is fixed at <strong id="cce_02_0321__b115531254102417">Addon</strong> and cannot be changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row154053481470"><td class="cellrowborder" valign="top" width="23.3023302330233%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cce_02_0321__p1641313485710">apiVersion</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.43184318431843%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cce_02_0321__p64135482718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.26582658265826%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cce_02_0321__p10416848774">API version. The value is fixed at <strong id="cce_02_0321__b198033518253">v3</strong> and cannot be changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row84065482073"><td class="cellrowborder" valign="top" width="23.3023302330233%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cce_02_0321__p542218481571">items</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.43184318431843%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cce_02_0321__p695232717465"><a href="#cce_02_0321__response_addontemplate">items</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.26582658265826%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cce_02_0321__p10425104817719">Add-on template list.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0321__response_addontemplate"></a><a name="response_addontemplate"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0321__response_addontemplate" 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_0321__row44291348170"><th align="left" class="cellrowborder" valign="top" width="23.18%" id="mcps1.3.4.4.2.4.1.1"><p id="cce_02_0321__p543310484712">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.88%" id="mcps1.3.4.4.2.4.1.2"><p id="cce_02_0321__p13434448376">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.940000000000005%" id="mcps1.3.4.4.2.4.1.3"><p id="cce_02_0321__p124368489711">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0321__row643064813711"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0321__p2043764815713">kind</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.88%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0321__p1437748272">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.940000000000005%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0321__p164384486720">API type. The value is fixed at <strong id="cce_02_0321__b27751215132612">Addon</strong> and cannot be changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row1243018486713"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0321__p114391048472">apiVersion</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.88%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0321__p1843917489718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.940000000000005%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0321__p1744110482718">API version. The value is fixed at <strong id="cce_02_0321__b11215421162613">v3</strong> and cannot be changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row164301848678"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0321__p244214489711">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.88%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0321__p14436484714"><a href="#cce_02_0321__response_metadata">metadata</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.940000000000005%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0321__p8445548477">Basic information about an add-on. Metadata is a collection of attributes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row154311848276"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0321__p444620481772">spec</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.88%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0321__p174465481719"><a href="#cce_02_0321__response_templatespec">spec</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.940000000000005%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0321__p94487481076">Detailed description of the add-on template.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0321__response_metadata"></a><a name="response_metadata"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0321__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_0321__row125591948576"><th align="left" class="cellrowborder" valign="top" width="18.07%" id="mcps1.3.4.5.2.4.1.1"><p id="cce_02_0321__p1356364810718">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.41%" id="mcps1.3.4.5.2.4.1.2"><p id="cce_02_0321__p115643481176">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.52%" id="mcps1.3.4.5.2.4.1.3"><p id="cce_02_0321__p135656484714">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0321__row1556074816713"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0321__p135661748372">uid</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.41%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0321__p105671148576">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.52%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0321__p165681148774">Unique ID of the add-on template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row456014481711"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0321__p25691248577">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.41%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0321__p957014811716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.52%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0321__p1357118481978">Add-on name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row156016481373"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0321__p25711348772">labels</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.41%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0321__p957220481473">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.52%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0321__p7574184815711">Add-on labels in the format of key-value pairs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row1556017486718"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0321__p1627174919717">annotations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.41%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0321__p1452116273317">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.52%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0321__p16281449173">Add-on annotations in the format of key-value pairs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row1561184817713"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0321__p662854913714">updateTimestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.41%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0321__p46281949777">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.52%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0321__p46283491473">Time when the add-on instance was updated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row145611748972"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0321__p36281249771">creationTimestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.41%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0321__p562814919715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.52%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0321__p106291491677">Time when the add-on instance was created</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0321__response_templatespec"></a><a name="response_templatespec"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0321__response_templatespec" 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_0321__row154538481711"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.6.2.4.1.1"><p id="cce_02_0321__p2459194811717">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.4.6.2.4.1.2"><p id="cce_02_0321__p14600486720">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.010000000000005%" id="mcps1.3.4.6.2.4.1.3"><p id="cce_02_0321__p1246211481575">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0321__row20453104810711"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0321__p746315482070">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0321__p124656481975">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.010000000000005%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0321__p14466184816713">Template type (helm or static).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row195354012410"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0321__p653517012414">require</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0321__p95361902419">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.010000000000005%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0321__p386319744919">Whether the add-on is installed by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row6454848176"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0321__p7467548678">labels</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0321__p84680481171">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.010000000000005%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0321__p846914481377">Group to which the template belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row34546481171"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0321__p94701448379">logoURL</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0321__p114701248473">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.010000000000005%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0321__p847224819712">URL of the logo image.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row194551748672"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0321__p047314481714">readmeURL</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0321__p154733481274">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.010000000000005%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0321__p44741488717">URL of the readme file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row11455134819720"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0321__p18475174810717">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0321__p12476748575">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.010000000000005%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0321__p44772487718">Template description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row154554485719"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0321__p847834811720">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0321__p447815488717">Array of <a href="#cce_02_0321__response_versions">versions</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.010000000000005%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0321__p104802481873">Template version details.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0321__response_versions"></a><a name="response_versions"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0321__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_0321__row25033482076"><th align="left" class="cellrowborder" valign="top" width="24.33756624337566%" id="mcps1.3.4.7.2.4.1.1"><p id="cce_02_0321__p1751394812714">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.40765923407659%" id="mcps1.3.4.7.2.4.1.2"><p id="cce_02_0321__p1251315481471">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.25477452254774%" id="mcps1.3.4.7.2.4.1.3"><p id="cce_02_0321__p651524811718">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0321__row1950510481713"><td class="cellrowborder" valign="top" width="24.33756624337566%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0321__p15151481575">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.40765923407659%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0321__p1516164814715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.25477452254774%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0321__p16517648271">Add-on version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row17505114811710"><td class="cellrowborder" valign="top" width="24.33756624337566%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0321__p85188481370">input</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.40765923407659%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0321__p45194481574">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.25477452254774%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0321__p13520548179">Add-on installation parameters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row1050614483713"><td class="cellrowborder" valign="top" width="24.33756624337566%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0321__p14522124819716">stable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.40765923407659%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0321__p1523448979">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.25477452254774%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0321__p9556142910493">Whether the add-on version is a stable release.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row1950654811719"><td class="cellrowborder" valign="top" width="24.33756624337566%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0321__p35250481077">translate</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.40765923407659%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0321__p1652712481373">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.25477452254774%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0321__p1852824812712">Translation information used by the GUI.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row1250712481677"><td class="cellrowborder" valign="top" width="24.33756624337566%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0321__p1852912482716">supportVersions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.40765923407659%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0321__p175294482715">Array of <a href="#cce_02_0321__response_supportVersions">supportVersions</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.25477452254774%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0321__p553115485720">Cluster versions that support the add-on template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row1950716485719"><td class="cellrowborder" valign="top" width="24.33756624337566%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0321__p1153115483716">creationTimestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.40765923407659%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0321__p85323486713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.25477452254774%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0321__p1553416484710">Creation time of the add-on instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row105081481473"><td class="cellrowborder" valign="top" width="24.33756624337566%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0321__p55352048275">updateTimestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.40765923407659%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0321__p15536184820711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.25477452254774%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0321__p1953717481674">Time when the add-on instance was updated.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0321__response_supportVersions"></a><a name="response_supportVersions"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0321__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_0321__row2492144815716"><th align="left" class="cellrowborder" valign="top" width="22.96%" id="mcps1.3.4.8.2.4.1.1"><p id="cce_02_0321__p349574812720">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.64%" id="mcps1.3.4.8.2.4.1.2"><p id="cce_02_0321__p164951482713">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.4%" id="mcps1.3.4.8.2.4.1.3"><p id="cce_02_0321__p249620488715">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0321__row154934480713"><td class="cellrowborder" valign="top" width="22.96%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0321__p1849715481715">clusterType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.64%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0321__p104971448375">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.4%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0321__p104991481572">Cluster type that supports the add-on template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0321__row1849315487718"><td class="cellrowborder" valign="top" width="22.96%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cce_02_0321__p164991648477">clusterVersion</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.64%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cce_02_0321__p125001448476">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.4%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cce_02_0321__p15017487716">Cluster versions that support the add-on template. The parameter value is a regular expression.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0321__p139754612295"><strong id="cce_02_0321__b1479891216389">Example response:</strong></p>
|
|
<pre class="screen" id="cce_02_0321__screen17410171011157">{
|
|
"kind": "Addon",
|
|
"apiVersion": "v3",
|
|
"items": [
|
|
{
|
|
"kind": "Addon",
|
|
"apiVersion": "v3",
|
|
"metadata": {
|
|
"uid": "coredns",
|
|
"name": "coredns",
|
|
"creationTimestamp": "2020-07-13T20:04:33Z",
|
|
"updateTimestamp": "2020-07-13T20:04:34Z"
|
|
},
|
|
"spec": {
|
|
"type": "helm",
|
|
"require": true,
|
|
"labels": [
|
|
"ServiceDiscovery"
|
|
],
|
|
"logoURL": "https://***/cce-addon-aw1hz2u/corednslogo.svg",
|
|
"description": "CoreDNS is a DNS server that chains plugins and provides Kubernetes DNS Services",
|
|
"versions": [
|
|
{
|
|
"version": "1.15.3",
|
|
"input": {
|
|
"basic": {
|
|
"cluster_ip": "10.247.3.10",
|
|
"platform": "linux-amd64",
|
|
"swr_addr": "10.125.13.11:20202",
|
|
"swr_user": "test"
|
|
},
|
|
"parameters": {
|
|
"custom": {
|
|
"stub_domains": "",
|
|
"upstream_nameservers": ""
|
|
},
|
|
"flavor1": {
|
|
"name": 2500,
|
|
"replicas": 2,
|
|
"resources": [
|
|
{
|
|
"limitsCpu": "500m",
|
|
"limitsMem": "512Mi",
|
|
"name": "coredns",
|
|
"requestsCpu": "500m",
|
|
"requestsMem": "512Mi"
|
|
}
|
|
]
|
|
},
|
|
"flavor2": {
|
|
"name": 5000,
|
|
"replicas": 2,
|
|
"resources": [
|
|
{
|
|
"limitsCpu": "1000m",
|
|
"limitsMem": "1024Mi",
|
|
"name": "coredns",
|
|
"requestsCpu": "1000m",
|
|
"requestsMem": "1024Mi"
|
|
}
|
|
]
|
|
},
|
|
"flavor3": {
|
|
"name": 10000,
|
|
"replicas": 2,
|
|
"resources": [
|
|
{
|
|
"limitsCpu": "2000m",
|
|
"limitsMem": "2048Mi",
|
|
"name": "coredns",
|
|
"requestsCpu": "2000m",
|
|
"requestsMem": "2048Mi"
|
|
}
|
|
]
|
|
},
|
|
"flavor4": {
|
|
"name": 20000,
|
|
"replicas": 4,
|
|
"resources": [
|
|
{
|
|
"limitsCpu": "2000m",
|
|
"limitsMem": "2048Mi",
|
|
"name": "coredns",
|
|
"requestsCpu": "2000m",
|
|
"requestsMem": "2048Mi"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"stable": true,
|
|
"translate": {
|
|
"en_US": {
|
|
"addon": {
|
|
"changeLog": "add workaround for klog/coredns crash issue",
|
|
"description": "CoreDNS is a DNS server that chains plugins and provides Kubernetes DNS Services"
|
|
},
|
|
"description": {
|
|
"Parameters.custom.stub_domains": "The target nameserver may itself be a Kubernetes service. For instance, you can run your own copy of dnsmasq to export custom DNS names into the ClusterDNS namespace, a JSON map using a DNS suffix key (e.g. "acme.local") and a value consisting of a JSON array of DNS IPs.",
|
|
"Parameters.custom.upstream_nameservers": "If specified, then the values specified replace the nameservers taken by default from the node's /etc/resolv.conf. Limits:a maximum of three upstream nameservers can be specified, A JSON array of DNS IPs.",
|
|
"Parameters.flavor1.description": "Concurrent domain name resolution ability - External domain name:2500 qps, Internal domain name:10000 qps",
|
|
"Parameters.flavor1.name": 2500,
|
|
"Parameters.flavor2.description": "Concurrent domain name resolution ability - External domain name:5000 qps, Internal domain name:20000 qps",
|
|
"Parameters.flavor2.name": 5000,
|
|
"Parameters.flavor3.description": "Concurrent domain name resolution ability - External domain name:10000 qps, Internal domain name:40000 qps",
|
|
"Parameters.flavor3.name": 10000,
|
|
"Parameters.flavor4.description": "Concurrent domain name resolution ability - External domain name:20000 qps, Internal domain name:80000 qps",
|
|
"Parameters.flavor4.name": 20000
|
|
},
|
|
"key": {
|
|
"Parameters.custom.stub_domains": "stub domain",
|
|
"Parameters.custom.upstream_nameservers": "upstream nameservers"
|
|
}
|
|
},
|
|
"fr_FR": {
|
|
"addon": {
|
|
"changeLog": "ajouter une solution de contournement pour le problème de plantage klog / coredns",
|
|
"description": "Un serveur DNS qui enchaîne les plug-ins et fournit des services DNS Kubernetes."
|
|
},
|
|
"description": {
|
|
"Parameters.custom.stub_domains": "Le serveur de noms cible peut lui-même être un service Kubernetes. Par exemple, vous pouvez exécuter votre propre copie de dnsmasq pour exporter des noms DNS personnalisés dans l'espace de noms ClusterDNS, une carte JSON à l'aide d'une clé de suffixe DNS (par exemple, «acme.local») et une valeur constituée d'un tableau JSON d'adresses IP DNS.",
|
|
"Parameters.custom.upstream_nameservers": "Si spécifié, les valeurs spécifiées remplacent les serveurs de noms pris par défaut dans le fichier /etc/resolv.conf du nœud. Limites: un maximum de trois serveurs de noms en amont peuvent être spécifiés, un tableau JSON d'adresses IP DNS.",
|
|
"Parameters.flavor1.description": "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 2500 qps, Nom de domaine interne: 10000 qp",
|
|
"Parameters.flavor1.name": 2500,
|
|
"Parameters.flavor2.description": "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 5000 qps, Nom de domaine interne: 20000 qp",
|
|
"Parameters.flavor2.name": 5000,
|
|
"Parameters.flavor3.description": "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 10000 qps, Nom de domaine interne: 40000 qp",
|
|
"Parameters.flavor3.name": 10000,
|
|
"Parameters.flavor4.description": "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 20000 qps, Nom de domaine interne: 80000 qp",
|
|
"Parameters.flavor4.name": 20000
|
|
},
|
|
"key": {
|
|
"Parameters.custom.stub_domains": "domaine stub",
|
|
"Parameters.custom.upstream_nameservers": "serveurs de noms en amont"
|
|
}
|
|
},
|
|
"zh_CN": {
|
|
"addon": {
|
|
"changeLog": "",
|
|
"description": ""
|
|
},
|
|
"description": {
|
|
"Parameters.custom.stub_domains": "",
|
|
"Parameters.custom.upstream_nameservers": "",
|
|
"Parameters.flavor1.description": "",
|
|
"Parameters.flavor1.name": 2500,
|
|
"Parameters.flavor2.description": "",
|
|
"Parameters.flavor2.name": 5000,
|
|
"Parameters.flavor3.description": "",
|
|
"Parameters.flavor3.name": 10000,
|
|
"Parameters.flavor4.description": "",
|
|
"Parameters.flavor4.name": 20000
|
|
},
|
|
"key": {
|
|
"Parameters.custom.stub_domains": "",
|
|
"Parameters.custom.upstream_nameservers": ""
|
|
}
|
|
}
|
|
},
|
|
"supportVersions": [
|
|
{
|
|
"clusterType": "VirtualMachine",
|
|
"clusterVersion": [
|
|
"v1.15.*"
|
|
]
|
|
}
|
|
],
|
|
"creationTimestamp": "2020-07-13T20:04:33Z",
|
|
"updateTimestamp": "2020-07-13T20:04:33Z"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="cce_02_0321__section764810491714"><h4 class="sectiontitle">Status Codes</h4><p id="cce_02_0321__p1688712963013"><a href="#cce_02_0321__en-us_topic_0079614900_table46761928">Table 9</a> describes the status codes of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0321__en-us_topic_0079614900_table46761928"></a><a name="en-us_topic_0079614900_table46761928"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0321__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_0321__en-us_topic_0079614900_row33254664"><th align="left" class="cellrowborder" valign="top" width="19.96%" id="mcps1.3.5.3.2.3.1.1"><p id="cce_02_0321__p55616028205955">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="80.04%" id="mcps1.3.5.3.2.3.1.2"><p id="cce_02_0321__p8604418205955">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0321__row176274101210"><td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.5.3.2.3.1.1 "><p id="cce_02_0321__p46285101728">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.04%" headers="mcps1.3.5.3.2.3.1.2 "><p id="cce_02_0321__p126288106215">OK</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0321__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>
|
|
|