forked from docs/doc-exports
zhengxiu
8f6b8d3664
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: zhengxiu <zhengxiu@huawei.com> Co-committed-by: zhengxiu <zhengxiu@huawei.com>
179 lines
14 KiB
HTML
179 lines
14 KiB
HTML
<a name="UpdateShrinkNodes"></a><a name="UpdateShrinkNodes"></a>
|
|
|
|
<h1 class="topictitle1">Scaling In a Cluster by Removing a Specific Node</h1>
|
|
<div id="body1708331107508"><div class="section" id="UpdateShrinkNodes__section13191124541016"><h4 class="sectiontitle">Function</h4><p id="UpdateShrinkNodes__p161911545201013">During a scale-in, the data on the to-be-removed nodes needs to be migrated to the remaining nodes. The timeout for data migration per node is 48 hours. Scale-in will fail if this timeout expires. When the cluster has large quantities of data, you are advised to manually adjust the data migration rate and avoid performing the migration during peak hours.</p>
|
|
<p id="UpdateShrinkNodes__p219119455109">This API is used to scale in a cluster by removing specified nodes. </p>
|
|
<div class="note" id="UpdateShrinkNodes__note18191164518101"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="UpdateShrinkNodes__p319194521010">All mission-critical data has been backed up before a cluster scale-in. This is to prevent data loss.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="UpdateShrinkNodes__section819113456108"><h4 class="sectiontitle">Calling Method</h4><p id="UpdateShrinkNodes__p16192104511013">For details, see <a href="css_03_0077.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="UpdateShrinkNodes__section1619244561018"><h4 class="sectiontitle">URI</h4><p id="UpdateShrinkNodes__p19192114513105">POST /v1.0/{project_id}/clusters/{cluster_id}/node/offline</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateShrinkNodes__table19192174541018" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdateShrinkNodes__row1919224512107"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateShrinkNodes__p6192164512103">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateShrinkNodes__p5192164512105">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateShrinkNodes__p2019211457108">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateShrinkNodes__p161921945171017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateShrinkNodes__row1219210451108"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateShrinkNodes__p1119274512104">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateShrinkNodes__p619304531018">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateShrinkNodes__p1619313454104">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateShrinkNodes__p1919318456102"><strong id="UpdateShrinkNodes__b1519364515109">Definition</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p7193445131020">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 id="UpdateShrinkNodes__p1419384591010"><strong id="UpdateShrinkNodes__b1919320458105">Constraints</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p12193134519108">N/A</p>
|
|
<p id="UpdateShrinkNodes__p141938456101"><strong id="UpdateShrinkNodes__b12193104551017">Value range</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p5193164516103">Project ID of the account.</p>
|
|
<p id="UpdateShrinkNodes__p121931745171010"><strong id="UpdateShrinkNodes__b5193845141016">Default value</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p17193174519107">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateShrinkNodes__row19192645161015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateShrinkNodes__p1219344501019">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateShrinkNodes__p1919314541016">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateShrinkNodes__p919384531015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateShrinkNodes__p1719394531019"><strong id="UpdateShrinkNodes__b18193134518103">Definition</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p81931745181012">ID of the cluster you want to scale in. For details about how to obtain the cluster ID, see <a href="css_03_0101.html">Obtaining the Cluster ID</a>.</p>
|
|
<p id="UpdateShrinkNodes__p141931245201018"><strong id="UpdateShrinkNodes__b9193194501015">Constraints</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p13193174591016">N/A</p>
|
|
<p id="UpdateShrinkNodes__p17193124591013"><strong id="UpdateShrinkNodes__b3193154512103">Value range</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p101933455108">Cluster ID.</p>
|
|
<p id="UpdateShrinkNodes__p121931545151018"><strong id="UpdateShrinkNodes__b819304521014">Default value</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p13193184591014">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateShrinkNodes__section11194104515105"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateShrinkNodes__request_ShrinkNodesReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="UpdateShrinkNodes__row319413453108"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="UpdateShrinkNodes__p31949451101">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="UpdateShrinkNodes__p1919444591017">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="UpdateShrinkNodes__p191941745111014">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="UpdateShrinkNodes__p20194194541018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateShrinkNodes__row6194104517109"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateShrinkNodes__p51941045121013">migrate_data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateShrinkNodes__p2019412457103">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateShrinkNodes__p919418451102">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateShrinkNodes__p101951445141013"><strong id="UpdateShrinkNodes__b1819534521018">Definition</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p161951945141010">Whether to migrate data.</p>
|
|
<p id="UpdateShrinkNodes__p519544516104"><strong id="UpdateShrinkNodes__b31951045101013">Value range</strong>:</p>
|
|
<ul id="UpdateShrinkNodes__ul12195144513101"><li id="UpdateShrinkNodes__li20195144511017"><p id="UpdateShrinkNodes__p619554531018"><a name="UpdateShrinkNodes__li20195144511017"></a><a name="li20195144511017"></a>true: Migrate data.</p>
|
|
</li><li id="UpdateShrinkNodes__li18195164518108"><p id="UpdateShrinkNodes__p1719574581020"><a name="UpdateShrinkNodes__li18195164518108"></a><a name="li18195164518108"></a>false: Do not migrate data.</p>
|
|
</li></ul>
|
|
<p id="UpdateShrinkNodes__p12195114510102"><strong id="UpdateShrinkNodes__b1919524511010">Default value</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p0195184515107">true</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateShrinkNodes__row519474581014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateShrinkNodes__p16195164541018">shrink_nodes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateShrinkNodes__p31953459109">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateShrinkNodes__p11951745131015">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateShrinkNodes__p1719512450105"><strong id="UpdateShrinkNodes__b13195194501012">Definition</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p51951145151017">ID of the node to be removed from the cluster.</p>
|
|
<p id="UpdateShrinkNodes__p20195184511109"><strong id="UpdateShrinkNodes__b1319512459108">Constraints</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p201954452102">N/A</p>
|
|
<p id="UpdateShrinkNodes__p11195945121013"><strong id="UpdateShrinkNodes__b20195745121017">Value range</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p519564515107">Obtain the <strong id="UpdateShrinkNodes__b141951459106">ID</strong> attribute in instances by referring to <a href="ShowClusterDetail.html">Querying Cluster Details</a>.</p>
|
|
<p id="UpdateShrinkNodes__p7195545201015"><strong id="UpdateShrinkNodes__b8195104521019">Default value</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p1196845161012">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateShrinkNodes__row1719417458101"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateShrinkNodes__p1419614510102">agency_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateShrinkNodes__p419618451102">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateShrinkNodes__p0196245191017">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateShrinkNodes__p1919634551011"><strong id="UpdateShrinkNodes__b1719664513100">Definition</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p4196144513109">Agency name. You can create an agency to allow CSS to call other cloud services.</p>
|
|
<p id="UpdateShrinkNodes__p111961545131019"><strong id="UpdateShrinkNodes__b14196204516107">Constraints</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p5196114541010">VPC permissions required by the agency: "vpc:subnets:get","vpc:ports:*".</p>
|
|
<p id="UpdateShrinkNodes__p619664521013">This parameter is mandatory when the new IAM plane is connected. This parameter is optional when the old IAM plane is connected.</p>
|
|
<p id="UpdateShrinkNodes__p0196174518100"><strong id="UpdateShrinkNodes__b81961645111013">Value range</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p1819684501016">N/A</p>
|
|
<p id="UpdateShrinkNodes__p14196124519108"><strong id="UpdateShrinkNodes__b1119654521015">Default value</strong>:</p>
|
|
<p id="UpdateShrinkNodes__p161968459100">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateShrinkNodes__section12196154520104"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateShrinkNodes__p819612450109"><strong id="UpdateShrinkNodes__b7196545171019">Status code: 200</strong></p>
|
|
<p id="UpdateShrinkNodes__p01962451106">Request succeeded.</p>
|
|
<p id="UpdateShrinkNodes__p131961545191018">None</p>
|
|
</div>
|
|
<div class="section" id="UpdateShrinkNodes__section919616455105"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateShrinkNodes__p1319611458103">Scale in a cluster by scaling in specified nodes.</p>
|
|
<pre class="screen" id="UpdateShrinkNodes__screen181970452107">POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/node/offline
|
|
|
|
{
|
|
"shrink_nodes" : [ "2077bdf3-b90d-412e-b460-635b9b159c11" ],
|
|
"migrate_data" : "true"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateShrinkNodes__section4197154512105"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateShrinkNodes__p419714515109">None</p>
|
|
</div>
|
|
<div class="section" id="UpdateShrinkNodes__section4386124501015"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateShrinkNodes__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateShrinkNodes__row4203124511103"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="UpdateShrinkNodes__p1238617453104">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="UpdateShrinkNodes__p9386645101013">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateShrinkNodes__row1520319453109"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateShrinkNodes__p11386145181019">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateShrinkNodes__p3386164501015">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateShrinkNodes__row122032454109"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateShrinkNodes__p1386154518106">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateShrinkNodes__p4386164519109">Invalid request.</p>
|
|
<p id="UpdateShrinkNodes__p1238618456103">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateShrinkNodes__row9203184517109"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateShrinkNodes__p7386194571019">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateShrinkNodes__p3386345171015">The request could not be completed due to a conflict with the current state of the resource.</p>
|
|
<p id="UpdateShrinkNodes__p15386445161017">The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateShrinkNodes__row72031145141015"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateShrinkNodes__p038611453103">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateShrinkNodes__p133869454105">The server did not meet one of the preconditions contained in the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateShrinkNodes__section13861459107"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateShrinkNodes__p2387164581013">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>
|
|
|