vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/css/api-ref/UpgradeDetail.html
Zheng, Xiu 3fa966049f css api 20240704 version 
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>
2024-07-22 17:01:37 +00:00

437 lines
30 KiB
HTML
Raw Blame History

<a name="UpgradeDetail"></a><a name="UpgradeDetail"></a>
<h1 class="topictitle1">Obtaining Upgrade Details</h1>
<div id="body0000001880559224"><div class="section" id="UpgradeDetail__section494793164615"><h4 class="sectiontitle">Function</h4><p id="UpgradeDetail__p095013310465">The upgrade takes a long time. You can call this API to check the upgrade progress on a node.</p>
</div>
<div class="section" id="UpgradeDetail__section129527354619"><h4 class="sectiontitle">Calling Method</h4><p id="UpgradeDetail__p11954153174619">For details, see <a href="css_03_0137.html">Calling APIs</a>.</p>
</div>
<div class="section" id="UpgradeDetail__section795619313469"><h4 class="sectiontitle">URI</h4><p id="UpgradeDetail__p1795817311466">GET /v1.0/{project_id}/clusters/{cluster_id}/upgrade/detail</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpgradeDetail__table99611338469" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="UpgradeDetail__row1695903194610"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpgradeDetail__p109627317461">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpgradeDetail__p896463124617">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpgradeDetail__p139654317468">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpgradeDetail__p1296813334611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpgradeDetail__row0960203154613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpgradeDetail__p19701532465">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpgradeDetail__p13971113124615">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpgradeDetail__p4973033462">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpgradeDetail__p119742384616">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="UpgradeDetail__row1796053184616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpgradeDetail__p10976173134618">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpgradeDetail__p10978103184620">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpgradeDetail__p119804354615">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpgradeDetail__p189817316466">ID of the cluster to be upgraded.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpgradeDetail__table15985739463" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="UpgradeDetail__row119831314464"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="UpgradeDetail__p59867374620">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="UpgradeDetail__p9987935461">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="UpgradeDetail__p1098913164619">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="UpgradeDetail__p399033204611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpgradeDetail__row79831313460"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpgradeDetail__p1199215324613">start</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpgradeDetail__p1299311394614">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpgradeDetail__p699583104612">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpgradeDetail__p199614312466">Offset. All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.</p>
</td>
</tr>
<tr id="UpgradeDetail__row12983531465"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpgradeDetail__p1499814317468">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpgradeDetail__p1502444617">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpgradeDetail__p1211449467">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpgradeDetail__p11317413465">Maximum number of connections displayed on each page.</p>
</td>
</tr>
<tr id="UpgradeDetail__row16983939468"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpgradeDetail__p1041142467">action_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpgradeDetail__p1361747465">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpgradeDetail__p13794164620">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpgradeDetail__p391042469">Upgrade querying behavior.</p>
<ul id="UpgradeDetail__ul161094124613"><li id="UpgradeDetail__li10111742468">If you need to query the cluster version upgrade details, leave this parameter blank.</li><li id="UpgradeDetail__li14121843461">If you need to query the details about AZ switchover, set this parameter to <strong id="UpgradeDetail__b16176141433414">AZ_MIGRATION</strong>.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpgradeDetail__section2141242460"><h4 class="sectiontitle">Request Parameters</h4><p id="UpgradeDetail__p7169434617">None</p>
</div>
<div class="section" id="UpgradeDetail__section11874114613"><h4 class="sectiontitle">Response Parameters</h4><p id="UpgradeDetail__p17198418465"><strong id="UpgradeDetail__b75305239051751">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpgradeDetail__response_GetUpgradeDetail" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="UpgradeDetail__row221947464"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="UpgradeDetail__p1624743465">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="UpgradeDetail__p2025114144617">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="UpgradeDetail__p112712444616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpgradeDetail__row6211942460"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpgradeDetail__p12919415468">totalSize</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpgradeDetail__p18309454617">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpgradeDetail__p193215410469">Number of times a request is delivered to the execution API.</p>
</td>
</tr>
<tr id="UpgradeDetail__row1121164194614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpgradeDetail__p14335412466">detailList</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpgradeDetail__p335246463">Array of <a href="#UpgradeDetail__response_GetUpgradeDetailInfo">GetUpgradeDetailInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpgradeDetail__p9371540462">Upgrade task details.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpgradeDetail__response_GetUpgradeDetailInfo"></a><a name="response_GetUpgradeDetailInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="UpgradeDetail__response_GetUpgradeDetailInfo" frame="border" border="1" rules="all"><caption><b>Table 4 </b>GetUpgradeDetailInfo</caption><thead align="left"><tr id="UpgradeDetail__row13915410464"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="UpgradeDetail__p151644464">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="UpgradeDetail__p553946468">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="UpgradeDetail__p18543434615">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpgradeDetail__row13918454619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p185614154618">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p1058544468">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p3598474620">Task ID</p>
</td>
</tr>
<tr id="UpgradeDetail__row153934154619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p161643465">startTime</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p1862840461">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p1464174144610">Start time of the upgrade.</p>
</td>
</tr>
<tr id="UpgradeDetail__row19391047461"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p206519415464">endTime</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p66711424615">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p968184124618">End time of the upgrade.</p>
</td>
</tr>
<tr id="UpgradeDetail__row193919464618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p117064154616">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p47217404611">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p1574154194613">Task status. The value can be:</p>
<ul id="UpgradeDetail__ul0758484617"><li id="UpgradeDetail__li1476104124618"><strong id="UpgradeDetail__b169718385219">RUNNING</strong>: The upgrade is in progress.</li><li id="UpgradeDetail__li177134104615"><strong id="UpgradeDetail__b204556483213">SUCCESS</strong>: The upgrade is successful.</li><li id="UpgradeDetail__li8791947461"><strong id="UpgradeDetail__b0194165232120">FAILED</strong>: The upgrade failed.</li><li id="UpgradeDetail__li4819434611"><strong id="UpgradeDetail__b54619110225">PARTIAL_FAILED</strong>: The upgrade partially failed.</li></ul>
</td>
</tr>
<tr id="UpgradeDetail__row183914411465"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p883154194615">agencyName</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p2844414460">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p12868410464">Agency name. You can create an agency to allow CSS to call other cloud services.</p>
</td>
</tr>
<tr id="UpgradeDetail__row16390414461"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p98744134615">imageInfo</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p1589747465"><a href="#UpgradeDetail__response_GetTargetImageIdDetail">GetTargetImageIdDetail</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p3911547465">Image details.</p>
</td>
</tr>
<tr id="UpgradeDetail__row940943461"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p7928415468">totalNodes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p11947474619">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p695144164618">Names of the nodes to be upgraded.</p>
</td>
</tr>
<tr id="UpgradeDetail__row04813454619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p13976414468">completedNodes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p198843462">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p17100134174611">Names of the nodes that have been upgraded.</p>
</td>
</tr>
<tr id="UpgradeDetail__row12481840467"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p510213434617">currentNodeName</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p610315410465">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p210584124610">Names of the nodes that are being upgraded.</p>
</td>
</tr>
<tr id="UpgradeDetail__row12488420465"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p610614474613">executeTimes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p15108547461">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p91101416466">Retried times</p>
</td>
</tr>
<tr id="UpgradeDetail__row1485412466"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p151111464612">migrateParam</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p15113041463">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p131151341462">Current upgrade behavior of the cluster. The value is displayed if the <strong id="UpgradeDetail__b15920184112275">query</strong> parameter exists.</p>
</td>
</tr>
<tr id="UpgradeDetail__row1481047465"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p101169464614">finalAzInfoMap</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p15118249468">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p1211911444613">Expected result of the cluster upgrade. The value is displayed if the <strong id="UpgradeDetail__b177009444279">query</strong> parameter exists.</p>
</td>
</tr>
<tr id="UpgradeDetail__row1848746465"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpgradeDetail__p31217454611">currentNodeDetail</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpgradeDetail__p1512314464619">Array of <a href="#UpgradeDetail__response_CurrentNodeDetail">CurrentNodeDetail</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpgradeDetail__p1512417454612">Task details of the node that is being upgraded.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpgradeDetail__response_GetTargetImageIdDetail"></a><a name="response_GetTargetImageIdDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="UpgradeDetail__response_GetTargetImageIdDetail" frame="border" border="1" rules="all"><caption><b>Table 5 </b>GetTargetImageIdDetail</caption><thead align="left"><tr id="UpgradeDetail__row131266414467"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="UpgradeDetail__p19129540469">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="UpgradeDetail__p513113464618">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="UpgradeDetail__p1513316484614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpgradeDetail__row11261146464"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpgradeDetail__p2136154134612">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpgradeDetail__p111375417463">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpgradeDetail__p2139144194615">ID of an image that can be upgraded.</p>
</td>
</tr>
<tr id="UpgradeDetail__row12126144104615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpgradeDetail__p3141134204619">displayName</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpgradeDetail__p15142204174610">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpgradeDetail__p13144164114611">Name of an image that can be upgraded.</p>
</td>
</tr>
<tr id="UpgradeDetail__row4126204164613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpgradeDetail__p41455419469">imageDesc</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpgradeDetail__p414754144611">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpgradeDetail__p111489418462">Image description.</p>
</td>
</tr>
<tr id="UpgradeDetail__row912615424617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpgradeDetail__p111507454619">datastoreType</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpgradeDetail__p515114124615">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpgradeDetail__p9153144104618">Image engine type.</p>
</td>
</tr>
<tr id="UpgradeDetail__row512613411466"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpgradeDetail__p20154164104612">datastoreVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpgradeDetail__p415612415461">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpgradeDetail__p131571544469">Image engine version.</p>
</td>
</tr>
<tr id="UpgradeDetail__row201271844461"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpgradeDetail__p1815916412467">priority</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpgradeDetail__p016212415466">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpgradeDetail__p7164144462">Priority</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpgradeDetail__response_CurrentNodeDetail"></a><a name="response_CurrentNodeDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="UpgradeDetail__response_CurrentNodeDetail" frame="border" border="1" rules="all"><caption><b>Table 6 </b>CurrentNodeDetail</caption><thead align="left"><tr id="UpgradeDetail__row916654104610"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="UpgradeDetail__p81691146461">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="UpgradeDetail__p7171104114616">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="UpgradeDetail__p41729424619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpgradeDetail__row316618444612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="UpgradeDetail__p6174124134616">order</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="UpgradeDetail__p617515413464">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="UpgradeDetail__p151771446460">Sequence number of an upgrade task.</p>
</td>
</tr>
<tr id="UpgradeDetail__row1316654184619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="UpgradeDetail__p17178194114610">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="UpgradeDetail__p518016417461">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="UpgradeDetail__p518117416463">Upgrade task name.</p>
</td>
</tr>
<tr id="UpgradeDetail__row141661444612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="UpgradeDetail__p51835419463">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="UpgradeDetail__p2185349469">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="UpgradeDetail__p17186941466">Status of the current task.</p>
</td>
</tr>
<tr id="UpgradeDetail__row1516619454616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="UpgradeDetail__p151888416462">desc</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="UpgradeDetail__p5189114184610">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="UpgradeDetail__p18191164114614">Description of the current task.</p>
</td>
</tr>
<tr id="UpgradeDetail__row1916624194611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="UpgradeDetail__p1419215418464">beginTime</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="UpgradeDetail__p11942464618">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="UpgradeDetail__p191969454611">Start time of the current task.</p>
</td>
</tr>
<tr id="UpgradeDetail__row616618417465"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="UpgradeDetail__p111975412461">endTime</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="UpgradeDetail__p91991942464">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="UpgradeDetail__p920013410465">End time of the current task.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpgradeDetail__section720264124610"><h4 class="sectiontitle">Request Example</h4><ul id="UpgradeDetail__ul6204104184618"><li id="UpgradeDetail__li182041144461">Example request for upgrading a cluster.<pre class="screen" id="UpgradeDetail__screen192061644468">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail</pre>
</li><li id="UpgradeDetail__li1220811410464">Example request for upgrading a cluster.<pre class="screen" id="UpgradeDetail__screen221012414462">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail?action_mode=AZ_MIGRATION</pre>
</li></ul>
</div>
<div class="section" id="UpgradeDetail__section42123414469"><h4 class="sectiontitle">Response Example</h4><p id="UpgradeDetail__p1421313444611"><strong id="UpgradeDetail__b31417434751751">Status code: 200</strong></p>
<p id="UpgradeDetail__p32159484611">The request is processed.</p>
<ul id="UpgradeDetail__ul92161442466"><li id="UpgradeDetail__li1021713474614">Example response for upgrading a cluster image.<pre class="screen" id="UpgradeDetail__screen19224148463">{
"totalSize" : 1,
"detailList" : [ {
"id" : "b7ac4c5b-3bda-4feb-a303-eb80f4bce986",
"startTime" : "2023-01-05T02:23:39",
"endTime" : "",
"status" : "RUNNING",
"agencyName" : "css_test_agency",
"imageInfo" : {
"id" : "439b5d30-5968-45df-b088-d030a858522d",
"displayName" : "7.10.2_22.5.1_1230",
"imageDesc" : "The latest image of version 7.10.2 will be officially released on December 30, 2022. the stability of the cluster has been optimized. It is recommended that you upgrade to this version.",
"datastoreType" : "elasticsearch",
"datastoreVersion" : "7.10.2",
"priority" : 16
},
"totalNodes" : "css-test-ess-esn-1-1,css-test-ess-esn-2-1,css-test-ess-esn-3-1",
"completedNodes" : "",
"currentNodeName" : "css-test-ess-esn-1-1",
"executeTimes" : "1",
"currentNodeDetail" : [ {
"order" : 0,
"name" : "Data migration",
"status" : "SUCCESS",
"desc" : "Data is migrated from a node to other nodes in the cluster by running the exclude command.",
"beginTime" : "2023-01-05T02:23:42",
"endTime" : "2023-01-05T02:29:51"
}, {
"order" : 12,
"name" : "Task status update",
"status" : "WAITING",
"desc" : "The cluster task status is refreshed. If there are no nodes to be replaced, the task is marked as completed. Otherwise, another node starts to be replaced.",
"beginTime" : "",
"endTime" : ""
} ]
} ]
}</pre>
</li><li id="UpgradeDetail__li727120434615">Example response for switching the AZ.<pre class="screen" id="UpgradeDetail__screen122780424615">{
"totalSize" : 1,
"detailList" : [ {
"id" : "8ebe958b-b8c6-4939-b5a7-85aee9468888",
"startTime" : "2022-12-29T08:32:29",
"endTime" : "",
"status" : "RUNNING",
"agencyName" : "css_test_agency",
"totalNodes" : "css-test-ess-esn-2-1,css-test-ess-esn-1-1,css-test-ess-esn-3-1",
"completedNodes" : "css-test-ess-esn-2-1",
"currentNodeName" : "css-test-ess-esn-1-1",
"executeTimes" : "1",
"migrateParam" : "{\"instType\":\"ess\",\"migrateType\":\"az_migrate\",\"sourceAz\":\"cn-north-4a\",\"targetAz\":\"cn-north-4c\"}",
"finalAzInfoMap" : "{\"cn-north-4c\":\"css-test-ess-esn-2-1,css-test-ess-esn-1-1,css-test-ess-esn-3-1\"}",
"currentNodeDetail" : [ {
"order" : 0,
"name" : "Data migration",
"status" : "SUCCESS",
"desc" : "Data is migrated from a node to other nodes in the cluster by running the exclude command.",
"beginTime" : "2022-12-29T08:41:05",
"endTime" : "2022-12-29T08:41:23"
}, {
"order" : 12,
"name" : "Task status update",
"status" : "RUNNING",
"desc" : "The cluster task status is refreshed. If there are no nodes to be replaced, the task is marked as completed. Otherwise, another node starts to be replaced.",
"beginTime" : "2023-01-04T06:53:42",
"endTime" : ""
} ]
} ]
}</pre>
</li></ul>
</div>
<div class="section" id="UpgradeDetail__section106596420469"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpgradeDetail__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpgradeDetail__row164176420465"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="UpgradeDetail__p19660194164611">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="UpgradeDetail__p13660144468">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpgradeDetail__row941744154612"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpgradeDetail__p16613484618">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpgradeDetail__p066124154618">The request is processed.</p>
</td>
</tr>
<tr id="UpgradeDetail__row1941784104618"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpgradeDetail__p266216415469">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpgradeDetail__p106636414610">Invalid request. Modify the request directly and do not attempt to retry it.</p>
</td>
</tr>
<tr id="UpgradeDetail__row2041716419465"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpgradeDetail__p76639444611">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpgradeDetail__p176646464614">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="UpgradeDetail__section666514104619"><h4 class="sectiontitle">Error Codes</h4><p id="UpgradeDetail__p86651424616">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>
View Git Blame Copy Permalink