yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a2e28c76231c99d8bbac87147becbb2b7e6be32e
doc-exports/docs/ucs/api-ref/UpdateCluster.html
qiujiandong1 535e30e292 UCS API initial update 20250523 version 
Reviewed-by: Gergo-Bence Lorincz <a200452876@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2026-02-23 09:12:31 +00:00

441 lines
30 KiB
HTML
Raw Blame History

<a name="UpdateCluster"></a><a name="UpdateCluster"></a>
<h1 class="topictitle1">Updating a Cluster</h1>
<div id="body1544241425717"><div class="section" id="UpdateCluster__section1644371475711"><h4 class="sectiontitle">Function</h4><p id="UpdateCluster__p134431914175713">This API is used to update a cluster. Currently, only the country/city of attached clusters and on-premises clusters, and the number of worker nodes in a multi-cloud cluster can be updated.</p>
</div>
<div class="section" id="UpdateCluster__section1644321485715"><h4 class="sectiontitle">URI</h4><p id="UpdateCluster__p2444191495719">PUT /v1/clusters/{clusterid}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__table10451101465712" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="UpdateCluster__row11449101416571"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="UpdateCluster__p84510143578">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="UpdateCluster__p345261410572">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="UpdateCluster__p0453314155710">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="UpdateCluster__p64537143576">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row94501514105717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdateCluster__p1045351415718">clusterid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdateCluster__p18454914105712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdateCluster__p14454191414575">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdateCluster__p6459141419577">Cluster ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateCluster__section746081417574"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="UpdateCluster__row046341475711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="UpdateCluster__p1147081445713">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="UpdateCluster__p17470181405711">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="UpdateCluster__p14470161455712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="UpdateCluster__p147115143571">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row946810145577"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateCluster__p1447141475717">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateCluster__p10477414105711">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateCluster__p94772149573">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateCluster__p1266617331861">Identity authentication information. 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.</p>
</td>
</tr>
<tr id="UpdateCluster__row17711917193"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateCluster__p20110172212422">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateCluster__p411018227429">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateCluster__p7110152218429">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateCluster__p12110172216422">Message body type (format). Only <strong id="UpdateCluster__b140610250441716">application/json</strong> is supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__request_UpdateClusterRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request body</caption><thead align="left"><tr id="UpdateCluster__row8479141435719"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateCluster__p648581475713">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateCluster__p848621416572">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateCluster__p448618144579">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateCluster__p1348718149575">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row11479101411570"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateCluster__p1148771425711">kind</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateCluster__p548731412574">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateCluster__p10488314135711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateCluster__p15488414195714">API type. The value is fixed at <strong id="UpdateCluster__b66653604142515">Cluster</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="UpdateCluster__row347920143579"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateCluster__p1748861415575">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateCluster__p104885146577">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateCluster__p174894142576">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateCluster__p1549417146579">API version. The value is fixed at <strong id="UpdateCluster__b143279093242517">v1</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="UpdateCluster__row184791314185714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateCluster__p144951014185716">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateCluster__p1149518149578">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateCluster__p17501614165716"><a href="#UpdateCluster__request_ObjectMeta">ObjectMeta</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateCluster__p115012143571">Basic information about the cluster. Metadata is a collection of attributes.</p>
</td>
</tr>
<tr id="UpdateCluster__row114798144578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateCluster__p185011414145712">spec</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateCluster__p75022142579">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateCluster__p12502714195711"><a href="#UpdateCluster__request_UpdateClusterSpec">UpdateClusterSpec</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateCluster__p9502714125718">Details about the cluster. UCS creates or updates the cluster based on <strong id="UpdateCluster__b89577730042528">spec</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdateCluster__request_ObjectMeta"></a><a name="request_ObjectMeta"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__request_ObjectMeta" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ObjectMeta</caption><thead align="left"><tr id="UpdateCluster__row1509181475714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="UpdateCluster__p205114148577">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="UpdateCluster__p1951118145574">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="UpdateCluster__p13511171495719">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="UpdateCluster__p1351191417570">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row2509714205712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdateCluster__p9517151415572">uid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdateCluster__p6517191415576">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdateCluster__p25181314105710">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdateCluster__p951813149572">Cluster ID</p>
</td>
</tr>
<tr id="UpdateCluster__row155093149572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdateCluster__p55191914135716">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdateCluster__p751915149579">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdateCluster__p7520171410578">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdateCluster__p1752018145571">Cluster name</p>
</td>
</tr>
<tr id="UpdateCluster__row950911415577"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdateCluster__p1052118143572">labels</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdateCluster__p1452241418574">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdateCluster__p8522414195711">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdateCluster__p052216145570">Labels</p>
</td>
</tr>
<tr id="UpdateCluster__row1951081418573"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdateCluster__p1052281415715">creationTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdateCluster__p1553081445716">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdateCluster__p2530111416572">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdateCluster__p1653121475712">Creation time. It is the UTC time in the RFC 3339 format.</p>
</td>
</tr>
<tr id="UpdateCluster__row651031418578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdateCluster__p65318148579">updateTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdateCluster__p45311914125714">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdateCluster__p14532514175710">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdateCluster__p25321114185710">Update timestamp</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdateCluster__request_UpdateClusterSpec"></a><a name="request_UpdateClusterSpec"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__request_UpdateClusterSpec" frame="border" border="1" rules="all"><caption><b>Table 5 </b>UpdateClusterSpec</caption><thead align="left"><tr id="UpdateCluster__row853351417574"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="UpdateCluster__p12546141410573">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="UpdateCluster__p2054651415572">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="UpdateCluster__p1954616147572">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="UpdateCluster__p1754771415574">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row9539171418577"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdateCluster__p1654751411575">country</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdateCluster__p185472148574">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdateCluster__p15548614155712">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdateCluster__p115484140570">Country where the cluster is located</p>
</td>
</tr>
<tr id="UpdateCluster__row25391514185718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdateCluster__p154901425711">city</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdateCluster__p455431465711">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdateCluster__p11555201412577">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdateCluster__p65551214205711">City where the cluster is located (consistent with the country)</p>
</td>
</tr>
<tr id="UpdateCluster__row554491413572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdateCluster__p655611418574">workerConfig</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdateCluster__p12556214185714">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdateCluster__p155571914145719"><a href="#UpdateCluster__request_WorkerConfig">WorkerConfig</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdateCluster__p85571914105712">Worker node configuration. This parameter is only available for multi-cloud clusters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdateCluster__request_WorkerConfig"></a><a name="request_WorkerConfig"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__request_WorkerConfig" frame="border" border="1" rules="all"><caption><b>Table 6 </b>WorkerConfig</caption><thead align="left"><tr id="UpdateCluster__row1855861425711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="UpdateCluster__p14565181405715">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.2"><p id="UpdateCluster__p11565141415574">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="UpdateCluster__p1056561415715">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.6.2.5.1.4"><p id="UpdateCluster__p1256611465711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row14558314165713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="UpdateCluster__p65668141570">replicas</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="UpdateCluster__p135669143571">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="UpdateCluster__p9572714145718">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="UpdateCluster__p2572181425711">The number of nodes</p>
</td>
</tr>
<tr id="UpdateCluster__row20559151415711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="UpdateCluster__p65731514155710">strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="UpdateCluster__p6573201418571">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="UpdateCluster__p25731814115711"><a href="#UpdateCluster__request_NodeUpgradeStrategy">NodeUpgradeStrategy</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="UpdateCluster__p1857961413573">Node update policy</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdateCluster__request_NodeUpgradeStrategy"></a><a name="request_NodeUpgradeStrategy"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__request_NodeUpgradeStrategy" frame="border" border="1" rules="all"><caption><b>Table 7 </b>NodeUpgradeStrategy</caption><thead align="left"><tr id="UpdateCluster__row358115145577"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.1"><p id="UpdateCluster__p135841114105716">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.2"><p id="UpdateCluster__p758515148578">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.3"><p id="UpdateCluster__p12585101415712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.7.2.5.1.4"><p id="UpdateCluster__p1958591413576">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row165821214115719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="UpdateCluster__p125863143574">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="UpdateCluster__p559161416572">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="UpdateCluster__p159291455711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="UpdateCluster__p175921314135713">Policy type</p>
</td>
</tr>
<tr id="UpdateCluster__row9582181410575"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="UpdateCluster__p1959221410576">rollingUpdate</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="UpdateCluster__p95931714205719">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="UpdateCluster__p1059371485714"><a href="#UpdateCluster__request_RollingUpdateNodeUpgradeStrategy">RollingUpdateNodeUpgradeStrategy</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="UpdateCluster__p659491495712">Rolling update</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdateCluster__request_RollingUpdateNodeUpgradeStrategy"></a><a name="request_RollingUpdateNodeUpgradeStrategy"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__request_RollingUpdateNodeUpgradeStrategy" frame="border" border="1" rules="all"><caption><b>Table 8 </b>RollingUpdateNodeUpgradeStrategy</caption><thead align="left"><tr id="UpdateCluster__row35941914145717"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.1"><p id="UpdateCluster__p19602201414573">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.2"><p id="UpdateCluster__p1460215142575">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.3"><p id="UpdateCluster__p12602101415720">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.8.2.5.1.4"><p id="UpdateCluster__p1660581411577">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row1859441419575"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.1 "><p id="UpdateCluster__p156059144573">maxUnavailable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.2 "><p id="UpdateCluster__p15610171485719">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.3 "><p id="UpdateCluster__p1661116143570">Object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.8.2.5.1.4 "><p id="UpdateCluster__p1261121418572">Maximum number of nodes that can be unavailable during an update</p>
</td>
</tr>
<tr id="UpdateCluster__row560051435714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.1 "><p id="UpdateCluster__p15612111495715">maxSurge</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.2 "><p id="UpdateCluster__p7618141475718">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.3 "><p id="UpdateCluster__p1261811405714">Object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.8.2.5.1.4 "><p id="UpdateCluster__p166181143579">Maximum number of nodes that can be created over the desired number of nodes</p>
</td>
</tr>
<tr id="UpdateCluster__row18600191412577"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.1 "><p id="UpdateCluster__p16619714115718">deletePolicy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.2 "><p id="UpdateCluster__p1861901414578">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.3 "><p id="UpdateCluster__p361911416579">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.8.2.5.1.4 "><p id="UpdateCluster__p1062041495710">Deletion policy. The options are <strong id="UpdateCluster__b631691254218">Random</strong>, <strong id="UpdateCluster__b11316111254219">Oldest</strong>, and <strong id="UpdateCluster__b631618126425">Newest</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateCluster__section762071415576"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateCluster__p1614592214429"><strong id="UpdateCluster__b145216594619">Status code: 200</strong></p>
<p id="UpdateCluster__p121451022194211">Cluster information updated.</p>
<p id="UpdateCluster__p31451822154214"><strong id="UpdateCluster__b410020904717">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__response_-" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Parameter in the response body</caption><thead align="left"><tr id="UpdateCluster__row11451222144218"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="UpdateCluster__p15145122114211">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="UpdateCluster__p1145172254216">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="UpdateCluster__p14145172284217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row131458220426"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdateCluster__p1214518223423">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdateCluster__p1914572219421">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdateCluster__p7145102217421">-</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateCluster__p71461822144213"><strong id="UpdateCluster__b69441628144716">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__table614662224213" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Parameter in the response body</caption><thead align="left"><tr id="UpdateCluster__row1314614223428"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="UpdateCluster__p1214642214217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="UpdateCluster__p41466225427">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="UpdateCluster__p141461722134213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row7146112234214"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdateCluster__p12146122210428">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdateCluster__p1514662213424">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdateCluster__p1614672212425">-</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateCluster__p15146152234214"><strong id="UpdateCluster__b51981242104718">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__table714614223420" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Parameter in the response body</caption><thead align="left"><tr id="UpdateCluster__row314632211428"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.1"><p id="UpdateCluster__p131471822144211">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.2"><p id="UpdateCluster__p31471822154212">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.9.2.4.1.3"><p id="UpdateCluster__p121471622104214">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row20146192220421"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="UpdateCluster__p014772234217">-</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="UpdateCluster__p114717224426">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="UpdateCluster__p18147152214219">-</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateCluster__section162013143578"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateCluster__p06217146574">Updating a cluster</p>
<pre class="screen" id="UpdateCluster__screen9627191414574">{
"kind" : "Cluster",
"apiVersion" : "v1",
"metadata" : {
"annotations" : {
"kubeconfig" : "{\"kind\":\"Config\",\"apiVersion\":\"v1\",\"preferences\":{},\"clusters\":[{\"name\":\"internalCluster\",\"cluster\":{\"server\":\"https://100.94.13.93:5443\",\"insecure-skip-tls-verify\":true}}],\"users\":[{\"name\":\"user\",\"user\":{\"client-certificate-data\":\"\",\"client-key-data\":\"\"}}],\"contexts\":[{\"name\":\"internal\",\"context\":{\"cluster\":\"internalCluster\",\"user\":\"user\"}}],\"current-context\":\"internal\"}"
}
},
"spec" : {
"country" : "AL",
"city" : "AL"
}
}</pre>
</div>
<div class="section" id="UpdateCluster__section1630914115718"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateCluster__p14630414185717"><strong id="UpdateCluster__b1851814715206">Status code: 200</strong></p>
<p id="UpdateCluster__p7190193420620">The cluster has been updated.</p>
<pre class="screen" id="UpdateCluster__screen51906341611">{ }</pre>
</div>
<div class="section" id="UpdateCluster__section3631181410576"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateCluster__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateCluster__row86361314115718"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="UpdateCluster__p4637514145710">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="UpdateCluster__p5638314175717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateCluster__row1263761445717"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateCluster__p4638181485711">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateCluster__p363812145571">The cluster has been updated.</p>
</td>
</tr>
<tr id="UpdateCluster__row463717143574"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateCluster__p1639151417577">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateCluster__p19644101445712">Client request error. The server could not execute the request.</p>
</td>
</tr>
<tr id="UpdateCluster__row1563771414576"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateCluster__p4645111405717">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateCluster__p3651161475718">The server refused the request.</p>
</td>
</tr>
<tr id="UpdateCluster__row126371814135719"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateCluster__p265117141571">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateCluster__p1265112145574">Internal server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateCluster__section19652191413577"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateCluster__p13652514125717">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">UCS Clusters</a></div>
</div>
</div>
View Git Blame Copy Permalink