forked from docs/doc-exports
Zheng, Xiu
99a2d77599
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>
199 lines
14 KiB
HTML
199 lines
14 KiB
HTML
<a name="css_03_0038"></a><a name="css_03_0038"></a>
|
|
|
|
<h1 class="topictitle1">Scaling Out a Cluster with Special Nodes</h1>
|
|
<div id="body1533866900365"><div class="section" id="css_03_0038__section75737501719"><h4 class="sectiontitle">Function</h4><p id="css_03_0038__p36983521712">This API is used to scale out a cluster with special nodes. That is, if a cluster has master, client, or cold data nodes, this API is used for scale-out.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0038__section115741054178"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0038__screen110063710489">POST /v1.0/{project_id}/clusters/{cluster_id}/role_extend</pre>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0038__table85787561718" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0038__row196991518175"><th align="left" class="cellrowborder" valign="top" width="17.11%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0038__p12699185101719">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.029999999999998%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0038__p1269975161713">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.09%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0038__p469911514175">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.77%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0038__p1869911561716">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0038__row10699115191716"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0038__p146994513174">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.029999999999998%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0038__p2699135131720">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.09%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0038__p1769911516173">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.77%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0038__p1869916551714">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0038__row1969995191712"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0038__p369914511174">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.029999999999998%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0038__p136997512171">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.09%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0038__p14699135121714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.77%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0038__p14699185101713">ID of the cluster to be scaled out.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0038__section258613510176"><h4 class="sectiontitle">Request</h4><p id="css_03_0038__p9408125115328"><a href="#css_03_0038__table758918551711">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0038__table758918551711"></a><a name="table758918551711"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0038__table758918551711" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="css_03_0038__row1569985151715"><th align="left" class="cellrowborder" valign="top" width="17.29%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0038__p869917510179">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.44%" id="mcps1.3.3.3.2.5.1.2"><p id="css_03_0038__p1069911517177">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.04%" id="mcps1.3.3.3.2.5.1.3"><p id="css_03_0038__p196991559177">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.230000000000004%" id="mcps1.3.3.3.2.5.1.4"><p id="css_03_0038__p106996511717">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0038__row4699125111715"><td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0038__p9699855174">grow</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0038__p2699135151718">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.04%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0038__p197007531711">Array of object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.230000000000004%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0038__p570020518172">Detailed description about the cluster scale-out request. For details, see <a href="#css_03_0038__table4597205181712">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0038__table4597205181712"></a><a name="table4597205181712"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0038__table4597205181712" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="css_03_0038__b84235270618226">grow</strong> field description</caption><thead align="left"><tr id="css_03_0038__row187001551176"><th align="left" class="cellrowborder" valign="top" width="17.252525252525253%" id="mcps1.3.3.4.2.5.1.1"><p id="css_03_0038__p9700145121717">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.41414141414141%" id="mcps1.3.3.4.2.5.1.2"><p id="css_03_0038__p2700659174">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.1010101010101%" id="mcps1.3.3.4.2.5.1.3"><p id="css_03_0038__p570012510179">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.23232323232323%" id="mcps1.3.3.4.2.5.1.4"><p id="css_03_0038__p117003551718">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0038__row117009591711"><td class="cellrowborder" valign="top" width="17.252525252525253%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0038__p1370013512174">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.41414141414141%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0038__p15242191272110">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.1010101010101%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0038__p770020521719">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.23232323232323%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0038__p182331572119">Type of the instance to be scaled out. Select at least one from <strong id="css_03_0038__b385020447418">ess</strong>, <strong id="css_03_0038__b829265004115">ess-cold</strong>, <strong id="css_03_0038__b675916538413">ess-master</strong>, and <strong id="css_03_0038__b3876155815412">ess-client</strong>.</p>
|
|
<p id="css_03_0038__p177003551712">You can only add instances, rather than increase storage capacity, on nodes of the <strong id="css_03_0038__b107331478443">ess-master</strong> and <strong id="css_03_0038__b56395210446">ess-client</strong> types.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0038__row17700852177"><td class="cellrowborder" valign="top" width="17.252525252525253%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0038__p12700450178">nodesize</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.41414141414141%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0038__p3700105131711">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.1010101010101%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0038__p370017511174">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.23232323232323%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0038__p147001955176">Number of instances to be scaled out. The total number of existing instances and newly added instances in a cluster cannot exceed 32.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0038__row1470013515179"><td class="cellrowborder" valign="top" width="17.252525252525253%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0038__p1570055171717">disksize</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.41414141414141%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0038__p970012511715">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.1010101010101%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0038__p15700155121712">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.23232323232323%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0038__p6700135111715">Storage capacity of the instance to be expanded. The total storage capacity of existing instances and newly added instances in a cluster cannot exceed the maximum instance storage capacity allowed when a cluster is being created. In addition, you can expand the instance storage capacity for a cluster for up to six times.</p>
|
|
<p id="css_03_0038__p188091148205">Unit: GB</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0038__section86215510171"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0038__p187506323315"><a href="#css_03_0038__table0621135181710">Table 4</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0038__table0621135181710"></a><a name="table0621135181710"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0038__table0621135181710" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="css_03_0038__row17701135201711"><th align="left" class="cellrowborder" valign="top" width="21.79217921792179%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0038__p18701455173">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.122912291229124%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0038__p137016514178">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.08490849084909%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0038__p9701165181715">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0038__row37013531713"><td class="cellrowborder" valign="top" width="21.79217921792179%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0038__p3701559179">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.122912291229124%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0038__p107015513172">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.08490849084909%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0038__p170110515176">Cluster ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0038__section1516452839"><h4 class="sectiontitle">Examples</h4><p id="css_03_0038__p157006513176">Example request</p>
|
|
<pre class="screen" id="css_03_0038__screen1700357178">POST v1.0/458d905f22da49c39f609e3347d65723/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/role_extend
|
|
{
|
|
"grow": [
|
|
{
|
|
"type": "ess-master",
|
|
"nodesize": 2,
|
|
"disksize": 0
|
|
},
|
|
{
|
|
"type": "ess",
|
|
"nodesize": 0,
|
|
"disksize": 50
|
|
},
|
|
{
|
|
"type": "ess-client",
|
|
"nodesize": 1,
|
|
"disksize": 0
|
|
}
|
|
]
|
|
}</pre>
|
|
<p id="css_03_0038__p1370116581710">Example response</p>
|
|
<pre class="screen" id="css_03_0038__screen147011957173">{
|
|
"id": "4f3deec3-efa8-4598-bf91-560aad1377a3"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0038__section262385181716"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0038__p46921709171"><a href="#css_03_0038__table12321369178">Table 5</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0038__table12321369178"></a><a name="table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0038__table12321369178" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="css_03_0038__en-us_topic_0000001342030725_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="15.939999999999998%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0038__en-us_topic_0000001342030725_p14560134151414">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.04%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0038__en-us_topic_0000001342030725_p5563194141411">Message</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.02%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0038__en-us_topic_0000001342030725_p256616411143">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0038__en-us_topic_0000001342030725_row129720356144"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0038__en-us_topic_0000001342030725_p1957004131410">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0038__en-us_topic_0000001342030725_p165731141171419">BadRequest</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0038__en-us_topic_0000001342030725_p65778413148">Invalid request.</p>
|
|
<p id="css_03_0038__en-us_topic_0000001342030725_p1557974171415">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0038__en-us_topic_0000001342030725_row8972103517147"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0038__en-us_topic_0000001342030725_p75841441191410">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0038__en-us_topic_0000001342030725_p258716416142">NotFound</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0038__en-us_topic_0000001342030725_p15589154118141">The requested resource cannot be found.</p>
|
|
<p id="css_03_0038__en-us_topic_0000001342030725_p14590164151410">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0038__en-us_topic_0000001342030725_row297223511416"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0038__en-us_topic_0000001342030725_p13595164131416">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0038__en-us_topic_0000001342030725_p9598741131416">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0038__en-us_topic_0000001342030725_p659994115146">The request is processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</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>
|
|
|