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>
170 lines
13 KiB
HTML
170 lines
13 KiB
HTML
<a name="UpdateExtendCluster"></a><a name="UpdateExtendCluster"></a>
|
|
|
|
<h1 class="topictitle1">Scaling Out a Cluster (Discarded)</h1>
|
|
<div id="body1708331107508"><div class="section" id="UpdateExtendCluster__section1866832114161"><h4 class="sectiontitle">Function</h4><p id="UpdateExtendCluster__p106689210164">This API is used to add instances to a cluster (only Elasticsearch instances can be added). This API can only scale out clusters that only have common nodes. Clusters with master, client, or cold data nodes cannot use this API.</p>
|
|
<p id="UpdateExtendCluster__p266892120167">For details about how to configure the number and storage capacity of instances in a cluster, see the API for <a href="UpdateExtendInstanceStorage.html">Adding Instances and Expanding Instance Storage Capacity</a>.</p>
|
|
</div>
|
|
<div class="section" id="UpdateExtendCluster__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="UpdateExtendCluster__p1766862112165">For details, see <a href="css_03_0077.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="UpdateExtendCluster__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="UpdateExtendCluster__p86691215162">POST /v1.0/{project_id}/clusters/{cluster_id}/extend</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateExtendCluster__table6670152111169" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdateExtendCluster__row1766917216162"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateExtendCluster__p36708212164">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateExtendCluster__p567052116162">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateExtendCluster__p11671182191610">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateExtendCluster__p667114214161">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateExtendCluster__row16701421111613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateExtendCluster__p8671192141619">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateExtendCluster__p6671172131611">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateExtendCluster__p166711321131618">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateExtendCluster__p10671122115167"><strong id="UpdateExtendCluster__b12671122114165">Definition</strong>:</p>
|
|
<p id="UpdateExtendCluster__p767118215167">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="UpdateExtendCluster__p10671152112162"><strong id="UpdateExtendCluster__b206717214167">Constraints</strong>:</p>
|
|
<p id="UpdateExtendCluster__p3671192151613">N/A</p>
|
|
<p id="UpdateExtendCluster__p116724210162"><strong id="UpdateExtendCluster__b2672122161612">Value range</strong>:</p>
|
|
<p id="UpdateExtendCluster__p267272110161">Project ID of the account.</p>
|
|
<p id="UpdateExtendCluster__p767292116162"><strong id="UpdateExtendCluster__b1167252116165">Default value</strong>:</p>
|
|
<p id="UpdateExtendCluster__p186723217169">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateExtendCluster__row36709210163"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateExtendCluster__p1967212181614">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateExtendCluster__p9672172141619">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateExtendCluster__p176721521171617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateExtendCluster__p1567252151618"><strong id="UpdateExtendCluster__b66721521191620">Definition</strong>:</p>
|
|
<p id="UpdateExtendCluster__p18672182161617">ID of the cluster you want to scale out. For details about how to obtain the cluster ID, see <a href="css_03_0101.html">Obtaining the Cluster ID</a>.</p>
|
|
<p id="UpdateExtendCluster__p267272115167"><strong id="UpdateExtendCluster__b1167212171620">Constraints</strong>:</p>
|
|
<p id="UpdateExtendCluster__p66728212160">N/A</p>
|
|
<p id="UpdateExtendCluster__p136722211163"><strong id="UpdateExtendCluster__b1767218216162">Value range</strong>:</p>
|
|
<p id="UpdateExtendCluster__p18672132120167">Cluster ID.</p>
|
|
<p id="UpdateExtendCluster__p186721021141612"><strong id="UpdateExtendCluster__b6672921111617">Default value</strong>:</p>
|
|
<p id="UpdateExtendCluster__p16728213168">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateExtendCluster__section1967342191615"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateExtendCluster__request_ExtendClusterReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="UpdateExtendCluster__row467332118168"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="UpdateExtendCluster__p15673142116169">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="UpdateExtendCluster__p767313211168">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="UpdateExtendCluster__p3673321161611">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="UpdateExtendCluster__p667382131619">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateExtendCluster__row8673112151617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateExtendCluster__p967382113162">grow</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateExtendCluster__p1867312119160">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateExtendCluster__p367302115168"><a href="#UpdateExtendCluster__request_ExtendClusterGrowReq">ExtendClusterGrowReq</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateExtendCluster__p1767412215168"><strong id="UpdateExtendCluster__b15674921181612">Definition</strong>:</p>
|
|
<p id="UpdateExtendCluster__p9674162161615">Detailed description about the cluster scale-out request.</p>
|
|
<p id="UpdateExtendCluster__p6674162116165"><strong id="UpdateExtendCluster__b166745218168">Constraints</strong>:</p>
|
|
<p id="UpdateExtendCluster__p1067419219169">N/A</p>
|
|
<p id="UpdateExtendCluster__p067411215169"><strong id="UpdateExtendCluster__b186742021131614">Value range</strong>:</p>
|
|
<p id="UpdateExtendCluster__p1867452151616">N/A</p>
|
|
<p id="UpdateExtendCluster__p1467482111612"><strong id="UpdateExtendCluster__b467492111611">Default value</strong>:</p>
|
|
<p id="UpdateExtendCluster__p267419214162">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="UpdateExtendCluster__request_ExtendClusterGrowReq"></a><a name="request_ExtendClusterGrowReq"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateExtendCluster__request_ExtendClusterGrowReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>ExtendClusterGrowReq</caption><thead align="left"><tr id="UpdateExtendCluster__row1967582101617"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="UpdateExtendCluster__p13675132171611">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="UpdateExtendCluster__p467511218162">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="UpdateExtendCluster__p1867582111166">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="UpdateExtendCluster__p1867515216161">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateExtendCluster__row96751121131613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateExtendCluster__p1467510214164">modifySize</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateExtendCluster__p166751221131612">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateExtendCluster__p16675152113165">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateExtendCluster__p86751321161614"><strong id="UpdateExtendCluster__b17675821101617">Definition</strong>:</p>
|
|
<p id="UpdateExtendCluster__p167511211163">Number of instances to be scaled out. The total number of existing instances and newly added instances in a cluster cannot exceed 32.</p>
|
|
<p id="UpdateExtendCluster__p1967542111164"><strong id="UpdateExtendCluster__b5675821141616">Constraints</strong>:</p>
|
|
<p id="UpdateExtendCluster__p367517219169">N/A</p>
|
|
<p id="UpdateExtendCluster__p46751521191616"><strong id="UpdateExtendCluster__b1767582118166">Value range</strong>:</p>
|
|
<p id="UpdateExtendCluster__p20675821181612">1-32</p>
|
|
<p id="UpdateExtendCluster__p20675122171612"><strong id="UpdateExtendCluster__b467611218169">Default value</strong>:</p>
|
|
<p id="UpdateExtendCluster__p1467632114166">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateExtendCluster__section16761213163"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateExtendCluster__p5676182131611"><strong id="UpdateExtendCluster__b767652131610">Status code: 200</strong></p>
|
|
<p id="UpdateExtendCluster__p14676152161611">Request succeeded.</p>
|
|
<p id="UpdateExtendCluster__p1667612213167">None</p>
|
|
</div>
|
|
<div class="section" id="UpdateExtendCluster__section1567642111167"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateExtendCluster__p10676172151618">Change the number of instances in the current cluster.</p>
|
|
<pre class="screen" id="UpdateExtendCluster__screen12676321151617">POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/extend
|
|
|
|
{
|
|
"grow" : {
|
|
"modifySize" : 4
|
|
},
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateExtendCluster__section66761621151613"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateExtendCluster__p186761921181614">None</p>
|
|
</div>
|
|
<div class="section" id="UpdateExtendCluster__section1789132116166"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateExtendCluster__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateExtendCluster__row1868262118163"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="UpdateExtendCluster__p1778962116168">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="UpdateExtendCluster__p107891921111610">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateExtendCluster__row36821921151618"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateExtendCluster__p167891721131616">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateExtendCluster__p7789152131611">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateExtendCluster__row868242171620"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateExtendCluster__p107894215162">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateExtendCluster__p15789152113168">Invalid request.</p>
|
|
<p id="UpdateExtendCluster__p578916213161">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateExtendCluster__row1168282116164"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateExtendCluster__p278992191610">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateExtendCluster__p187891121101616">The requested resource could not be found.</p>
|
|
<p id="UpdateExtendCluster__p1378982171617">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateExtendCluster__section77896210161"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateExtendCluster__p20789921131611">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>
|
|
|