yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
0c8e63f4b08baba088b035591beb782cd5ddba76
doc-exports/docs/css/api-ref/UpgradeDetail.html
zhengxiu 8f6b8d3664 css api 25.6.0 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: zhengxiu <zhengxiu@huawei.com>
Co-committed-by: zhengxiu <zhengxiu@huawei.com>
2025-11-25 11:21:12 +00:00

590 lines
28 KiB
HTML
Raw Blame History

<a name="UpgradeDetail"></a><a name="UpgradeDetail"></a>
<h1 class="topictitle1">Obtaining Details About a Cluster Upgrade or AZ Switchover</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>By deploying a CSS cluster across multiple AZs, you can increase the cluster's availability, lower the likelihood of data loss, and minimize service downtime. You can deploy a cluster across two or three AZs within a region. The upgrade may take a long time. This API can be used to check phase-by-phase information during a cluster upgrade or AZ switchover.</p>
</div>
<div class="section" id="UpgradeDetail__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p>For details, see <a href="css_03_0077.html">Calling APIs</a>.</p>
</div>
<div class="section" id="UpgradeDetail__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p>GET /v1.0/{project_id}/clusters/{cluster_id}/upgrade/detail</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p><strong>Definition</strong>:</p>
<p>Project ID. For details about how to obtain the project ID and name, see <a href="css_03_0071.html">Obtaining the Project ID and Name</a>.</p>
<p><strong>Constraints</strong>:</p>
<p>N/A</p>
<p><strong>Value range</strong>:</p>
<p>Project ID of the account.</p>
<p><strong>Default value</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p><strong>Definition</strong>:</p>
<p>ID of the cluster to be upgraded. For details about how to obtain the cluster ID, see <a href="css_03_0101.html">Obtaining the Cluster ID</a>.</p>
<p><strong>Constraints</strong>:</p>
<p>N/A</p>
<p><strong>Value range</strong>:</p>
<p>Cluster ID.</p>
<p><strong>Default value</strong>:</p>
<p>N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p><strong>Definition</strong>:</p>
<p>The start value of the query. The default value is 1, indicating that the query starts from the first task.</p>
<p><strong>Constraints</strong>:</p>
<p>N/A</p>
<p><strong>Value range</strong>:</p>
<p>1-1000</p>
<p><strong>Default value</strong>:</p>
<p>1</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p><strong>Definition</strong>:</p>
<p>Number of AZs to be queried. The default value is <strong>10</strong>, indicating that 10 AZs are queried at a time.</p>
<p><strong>Constraints</strong>:</p>
<p>N/A</p>
<p><strong>Value range</strong>:</p>
<p>1-1000</p>
<p><strong>Default value</strong>:</p>
<p>10</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p>action_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p><strong>Definition</strong>:</p>
<p>Query details about a cluster upgrade or AZ change operation.</p>
<p><strong>Constraints</strong>:</p>
<p>N/A</p>
<p><strong>Value range</strong>:</p>
<ul><li><p><strong>UPGRADING</strong>: query cluster upgrade details.</p>
</li><li><p><strong>AZ_MIGRATION</strong>: query AZ change details.</p>
</li></ul>
<p><strong>Default value</strong>:</p>
<p>UPGRADING</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4><p>None</p>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>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><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p>totalSize</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Total number of cluster upgrade or AZ change tasks.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p>detailList</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p>Array of <a href="#UpgradeDetail__response_GetUpgradeDetailInfo">GetUpgradeDetailInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Details of cluster upgrade or AZ change tasks.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</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><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>ID of the upgrade or AZ change task.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>startTime</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Start time of an upgrade or AZ change task.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>endTime</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>End time of an upgrade or AZ change task.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Status of an upgrade or AZ change task.</p>
<p><strong>Value range</strong>:</p>
<ul><li><p><strong>RUNNING</strong>: The task is being executed.</p>
</li><li><p><strong>SUCCESS</strong>: The task is successful.</p>
</li><li><p>FAILED: The job failed.</p>
</li><li><p><strong>PARTIAL_FAILED</strong>: The task failed partially.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>agencyName</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Agency name. You can create an agency to allow CSS to call other cloud services.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>imageInfo</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p><a href="#UpgradeDetail__response_GetTargetImageIdDetail">GetTargetImageIdDetail</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Image details.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>totalNodes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Names of all nodes that need to be upgraded or switched to another AZ.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>completedNodes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Nodes where upgrade or AZ change tasks have been completed.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>currentNodeName</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Name of the node that is being upgraded or switched to another AZ.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>executeTimes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Number of times the upgrade or AZ change task was retried.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>migrateParam</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>This parameter is available only when <strong>action_mode</strong> is set to <strong>AZ_MIGRATION</strong>. It indicates the request parameter of the AZ change task.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>finalAzInfoMap</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>This parameter is available only when <strong>action_mode</strong> is set to <strong>AZ_MIGRATION</strong>. It indicates the AZ details of each node after AZ switchover.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>currentNodeDetail</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>Array of <a href="#UpgradeDetail__response_CurrentNodeDetail">CurrentNodeDetail</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Task details of the node that is being upgraded or switched to another AZ.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>batchSize</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Number of nodes where data is being migrated concurrently.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>currentBatchNodes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Nodes where data is being migrated.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</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><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.5.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>ID of an image that can be upgraded.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>displayName</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Name of an image that can be upgraded.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>imageDesc</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Image description.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>datastoreType</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Cluster engine type.</p>
<p><strong>Value range</strong>:</p>
<ul><li><p>elasticsearch: Cloud Search Service (CSS) provides distributed search capabilities, log analytics, reporting, and semantic search based on open-source Elasticsearch.</p>
</li><li><p>logstash: Provides functions such as data ingestion, transformation, cleaning, and parsing based on open-source Logstash.</p>
</li><li><p>opensearch: Provides distributed search, log analytics, reporting, and semantic search based on open-source OpenSearch. It is the future version of CSS's Elasticsearch clusters.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>datastoreVersion</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Image engine version.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>priority</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Priority of the target image. A larger value indicates a higher priority.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</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><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.6.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>order</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>SN of the upgrade or AZ switchover task.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Name of the upgrade or AZ switchover task.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Status of the upgrade or AZ change task of the current cluster.</p>
<p><strong>Value range</strong>:</p>
<ul><li><p><strong>RUNNING</strong>: running</p>
</li><li><p><strong>SUCCESS</strong></p>
</li><li><p><strong>FAILED</strong></p>
</li><li><p><strong>WAITING</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>desc</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Description of the upgrade or AZ change task of the current cluster.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>beginTime</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>Start time of the upgrade or AZ change task of the current cluster.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>endTime</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p><strong>Definition</strong>:</p>
<p>End time of the upgrade or AZ change task of the current cluster.</p>
<p><strong>Value range</strong>:</p>
<p>N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><ul><li><p>Query cluster upgrade details.</p>
<pre class="screen">GET https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail</pre>
</li><li><p>Query details about a cluster AZ change task.</p>
<pre class="screen">GET https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail?action_mode=AZ_MIGRATION</pre>
</li></ul>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>Request succeeded.</p>
<ul><li><p>Example response for querying cluster upgrade details.</p>
<pre class="screen">{
"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><p>Example response for querying cluster AZ change details.</p>
<pre class="screen">{
"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"><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><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>Request succeeded.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>Invalid request.</p>
<p>The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>Request rejected.</p>
<p>The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="css_03_0076.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="cluster_management.html">Cluster Management</a></div>
</div>
</div>
View Git Blame Copy Permalink