forked from docs/doc-exports
Zheng, Xiu
3fa966049f
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com> Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
185 lines
12 KiB
HTML
185 lines
12 KiB
HTML
<a name="ListImages"></a><a name="ListImages"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining a Target Image ID</h1>
|
|
<div id="body0000001880399332"><div class="section" id="ListImages__section105709354618"><h4 class="sectiontitle">Function</h4><p id="ListImages__p2572630461">This API is used to obtain the ID of an image that can be upgraded in the current cluster.</p>
|
|
</div>
|
|
<div class="section" id="ListImages__section157473124611"><h4 class="sectiontitle">Calling Method</h4><p id="ListImages__p657617334613">For details, see <a href="css_03_0137.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="ListImages__section65781315468"><h4 class="sectiontitle">URI</h4><p id="ListImages__p16580163104616">GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/images</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListImages__table125842344617" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="ListImages__row258253104613"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ListImages__p45842312467">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ListImages__p1858673144615">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ListImages__p175878314612">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ListImages__p5589153124613">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListImages__row175821831467"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListImages__p1759116394610">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListImages__p1759213311469">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListImages__p195947334612">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListImages__p1159613316462">Project ID. For details about how to obtain a project ID, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListImages__row205821035463"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListImages__p4597183154614">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListImages__p135991634468">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListImages__p20601173204616">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListImages__p1960223174614">ID of the cluster to be upgraded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListImages__row185822312463"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListImages__p1160411313467">upgrade_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListImages__p96069364613">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListImages__p166078334616">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListImages__p260933164618">Version type. The value can be:</p>
|
|
<ul id="ListImages__ul1961173124616"><li id="ListImages__li6612103184620"><strong id="ListImages__b157911527181712">same</strong>: upgrade to the same version.</li><li id="ListImages__li261343124619"><strong id="ListImages__b77240159051436">cross</strong>: upgrade to a different version.</li><li id="ListImages__li146151344619"><strong id="ListImages__b41005153651448">crossEngine</strong>: cross-engine upgrade.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListImages__section56174394613"><h4 class="sectiontitle">Request Parameters</h4><p id="ListImages__p18619432468">None</p>
|
|
</div>
|
|
<div class="section" id="ListImages__section1962010318466"><h4 class="sectiontitle">Response Parameters</h4><p id="ListImages__p116227314612"><strong id="ListImages__b1860413487176">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListImages__response_GetTargetImageId" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="ListImages__row86242334611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="ListImages__p1062716310461">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="ListImages__p9628139461">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="ListImages__p186301316465">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListImages__row1624143104619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ListImages__p663213314616">needUploadUpgradePlugin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ListImages__p136331732461">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ListImages__p126351933466">Indicates whether to upload the plug-in of the target version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListImages__row18624123184615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ListImages__p76371135466">imageInfoList</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ListImages__p206396319465">Array of <a href="#ListImages__response_GetTargetImageIdDetail">GetTargetImageIdDetail</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ListImages__p10640183194616">Image details.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListImages__response_GetTargetImageIdDetail"></a><a name="response_GetTargetImageIdDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="ListImages__response_GetTargetImageIdDetail" frame="border" border="1" rules="all"><caption><b>Table 3 </b>GetTargetImageIdDetail</caption><thead align="left"><tr id="ListImages__row196421431463"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="ListImages__p5645113124615">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="ListImages__p264720334614">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="ListImages__p176495320464">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListImages__row1264213164613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListImages__p8650133174617">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListImages__p565283194613">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListImages__p365317316463">ID of an image that can be upgraded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListImages__row1764212319466"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListImages__p7655103104610">displayName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListImages__p065633204620">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListImages__p1165853134618">Name of an image that can be upgraded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListImages__row126421933466"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListImages__p14659439465">imageDesc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListImages__p146611310466">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListImages__p366212354617">Image description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListImages__row864223144611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListImages__p1966453174619">datastoreType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListImages__p1066623194617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListImages__p266910314463">Image engine type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListImages__row864311316468"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListImages__p1867093154620">datastoreVersion</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListImages__p7672143154615">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListImages__p467343194615">Image engine version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListImages__row136431637465"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListImages__p12675433461">priority</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListImages__p867753154612">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListImages__p76793313465">Priority</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListImages__section1468011315461"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="ListImages__screen1368318312468">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/target/cross/images
|
|
|
|
{
|
|
"needUploadUpgradePlugin" : false,
|
|
"imageInfoList" : [ ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ListImages__section116926394616"><h4 class="sectiontitle">Response Example</h4><p id="ListImages__p146932319469"><strong id="ListImages__b13865104919178">Status code: 200</strong></p>
|
|
<p id="ListImages__p869514313466">The request is processed.</p>
|
|
<pre class="screen" id="ListImages__screen206971830468">{
|
|
"needUploadUpgradePlugin" : false,
|
|
"imageInfoList" : [ ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ListImages__section1287615315468"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListImages__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListImages__row18878163134617"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="ListImages__p8880531461">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="ListImages__p15649424617">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListImages__row11878133104612"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListImages__p656510404610">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListImages__p12566449462">The request is processed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListImages__row1387818316465"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListImages__p956618413460">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListImages__p205677415465">Invalid request. Modify the request directly and do not attempt to retry it.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListImages__row128781533462"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListImages__p195678484617">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListImages__p25681145465">The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListImages__section125690474617"><h4 class="sectiontitle">Error Codes</h4><p id="ListImages__p256911417461">For details, see <a href="css_03_0076.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0008.html">Cluster Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|