vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/mrs/api-ref/mrs_02_0056.html
Yang, Tong bd2b57f749 MRS API 2.0.38.SP20 version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Yang, Tong <yangtong2@huawei.com>
Co-committed-by: Yang, Tong <yangtong2@huawei.com>
2022-11-16 15:06:08 +00:00

726 lines
67 KiB
HTML
Raw Blame History

<a name="mrs_02_0056"></a><a name="mrs_02_0056"></a>
<h1 class="topictitle1">Configuring an Auto Scaling Rule</h1>
<div id="body1516674287370"><div class="section" id="mrs_02_0056__section17052835105155"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0056__p5939573317534">This API is used to configure an auto scaling rule.</p>
<p id="mrs_02_0056__p56103349105157">The API used for cluster creation and job execution can also be used to create an auto scaling rule.</p>
</div>
<div class="section" id="mrs_02_0056__section161439810524"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0056__ul6428132114144"><li id="mrs_02_0056__li4666644514144">Format<p id="mrs_02_0056__p27607564141536"><a name="mrs_02_0056__li4666644514144"></a><a name="li4666644514144"></a>POST /v1.1/{project_id}/autoscaling-policy/{cluster_id}</p>
</li><li id="mrs_02_0056__li23642503141558">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0056__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0056__row33700024194754"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="mrs_02_0056__p16571835194812"><strong id="mrs_02_0056__b4115161720318">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="mrs_02_0056__p141410194812"><strong id="mrs_02_0056__b353812019314">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="mrs_02_0056__p11454278194812"><strong id="mrs_02_0056__b32828241738">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0056__row37407495194754"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0056__p56702435194812">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0056__p29494508194812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0056__p40820562194812">Project ID. For details on how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="mrs_02_0056__row9793450141337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0056__p42588366141346">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0056__p27105608141346">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0056__p6137976141354">Cluster ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="mrs_02_0056__section7976792193238"><h4 class="sectiontitle">Request</h4><p id="mrs_02_0056__p1842961591514"><strong id="mrs_02_0056__b139822112354">Request parameters</strong></p>
<p id="mrs_02_0056__p106160258151"><a href="#mrs_02_0056__table27243156151210">Table 2</a> and <a href="#mrs_02_0056__table50379282141720">Table 3</a> describe the request parameters.</p>
<div class="tablenoborder"><a name="mrs_02_0056__table27243156151210"></a><a name="table27243156151210"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0056__table27243156151210" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="mrs_02_0056__b1531242131511">node_group</strong> parameter description</caption><thead align="left"><tr id="mrs_02_0056__row17848224151210"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.4.2.5.1.1"><p id="mrs_02_0056__p59344636151210"><strong id="mrs_02_0056__b1432318461618">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.4.2.5.1.2"><p id="mrs_02_0056__p42186216151210"><strong id="mrs_02_0056__b6631250167">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.4.2.5.1.3"><p id="mrs_02_0056__p61640332151210">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.4.2.5.1.4"><p id="mrs_02_0056__p26811025151210">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0056__row39972639151210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.1 "><p id="mrs_02_0056__p16558360151210">node_group</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.4.2.5.1.2 "><p id="mrs_02_0056__p66158789151210">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.4.2.5.1.3 "><p id="mrs_02_0056__p57261711151210">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.4.2.5.1.4 "><p id="mrs_02_0056__p7687005151210">Type of the node to which an auto scaling rule applies. Currently, only Task nodes support auto scaling rules, that is, the request value is <strong id="mrs_02_0056__b2058614615174">task_node_default_group</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="mrs_02_0056__table50379282141720"></a><a name="table50379282141720"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0056__table50379282141720" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="mrs_02_0056__b1768243673115322">auto_scaling_policy</strong> parameter description</caption><thead align="left"><tr id="mrs_02_0056__en-us_topic_0264280076_raf51026a1f504a8788e1403658120f2f"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.5.2.5.1.1"><p id="mrs_02_0056__en-us_topic_0264280076_a6b57643863a6437a8c107916b9c7695d"><strong id="mrs_02_0056__b1280997860">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.5.2.5.1.2"><p id="mrs_02_0056__en-us_topic_0264280076_a3fff5ea955e54459addfcbbb35b643ec"><strong id="mrs_02_0056__b1514310024">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.5.2.5.1.3"><p id="mrs_02_0056__en-us_topic_0264280076_aa1457e2336bd448ea6d9616e20227777">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.5.2.5.1.4"><p id="mrs_02_0056__en-us_topic_0264280076_a5321d724cd884c23b9ae748f98ba4424"><strong id="mrs_02_0056__b1555571780">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0056__en-us_topic_0264280076_ra90fcd7439104b2c98d8b7081bfdef71"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.5.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a8e70a35d4222449cb92a4041ef7f0137">auto_scaling_enable</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_ae90c66ff525b4f18b199fba818fcc23e">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a2c10267f0ea74faba0b9fb771d478e67">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.5.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_a8b16bd6c0885436e8051b80f0aea7c8d">Whether to enable the auto scaling rule.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r1fe6b7d60f7345d3b8d1c1d8cb8806bd"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.5.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a379d490f2095437fad3072496b931b39">min_capacity</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a67bf7a6b811a47d1accfd408095436fb">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_en-us_topic_0110581924_p230787112654">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.5.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_a6339dac619fd4e838c5285c78f3162f9">Minimum number of nodes left in the node group.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_ac2a776ad7e134fadb625996c4d1d83d6">Value range: 0 to 500</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r8b569e44ff74496d9a7eb20ac8a742e4"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.5.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a7eaed7f858d7454b8c65783319c39b04">max_capacity</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a67bf8fb9a84542bd8757eeb97a31418f">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a3ecf064ee466445781aeb1a335395cba">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.5.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_a27bf42b5a44f47378f54aad66fef804f">Maximum number of nodes in the node group.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a480eee70830e4129964adad7def22b88">Value range: 0 to 500</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row109862440157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.5.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p99881444155">resources_plans</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p1998854481510">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p59886442157">List</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.5.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p189881644171514">Resource plan list. For details, see <a href="#mrs_02_0056__table1979310416120">Table 4</a>. If this parameter is left blank, the resource plan is disabled.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p9402141913220">When auto scaling is enabled, either a resource plan or an auto scaling rule must be configured.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p332510443181">MRS 1.6.3 or later supports this parameter.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row36011313174"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.5.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p337232320178">exec_scripts</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p337220231170">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p11372152341713">List</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.5.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p93729233178">List of custom scaling automation scripts. For details, see <a href="#mrs_02_0056__tefd2eb7c7838496eadbf4b310193de4a">Table 5</a>. If this parameter is left blank, a hook script is disabled.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p03726234173">MRS 1.7.2 or later supports this parameter.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r4755a3babff849968d83bd43129dc7eb"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.5.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a308e43c85e40439b8c59d08440843dc6">rules</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a98d5257b9540482989b03783ec10a561">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.5.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_ae314628f2d8a4766924313079bbabe68">List</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.5.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_ac2e02b36ba1e434fb0df7479bd8acd50">List of auto scaling rules. For details, see <a href="#mrs_02_0056__t46230cdbc4f641f6b17d64de5747728b">Table 6</a>.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p6516143522217">When auto scaling is enabled, either a resource plan or an auto scaling rule must be configured.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="mrs_02_0056__table1979310416120"></a><a name="table1979310416120"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0056__table1979310416120" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="mrs_02_0056__b80275982115322">resources_plan</strong> parameter description</caption><thead align="left"><tr id="mrs_02_0056__en-us_topic_0264280076_row21077515215"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.6.2.5.1.1"><p id="mrs_02_0056__en-us_topic_0264280076_p11361051162118"><strong id="mrs_02_0056__b1902915787">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.6.2.5.1.2"><p id="mrs_02_0056__en-us_topic_0264280076_p1815835115218"><strong id="mrs_02_0056__b1048130425">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.6.2.5.1.3"><p id="mrs_02_0056__en-us_topic_0264280076_p2018015511218">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.6.2.5.1.4"><p id="mrs_02_0056__en-us_topic_0264280076_p5198351122117"><strong id="mrs_02_0056__b1144564872">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0056__en-us_topic_0264280076_row1121555192110"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.6.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p18632144118282">period_type</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.6.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p4632164118286">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.6.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p166321418282">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.6.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p963214419289">Cycle type of a resource plan. Currently, only the following cycle type is supported:</p>
<ul id="mrs_02_0056__en-us_topic_0264280076_ul363284116288"><li id="mrs_02_0056__en-us_topic_0264280076_li19632041182813">daily</li></ul>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row1531855116213"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.6.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p11633174182818">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.6.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p196331041132814">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.6.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p19633114122816">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.6.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p13633154112816">Start time of a resource plan. The value is in the format of <strong id="mrs_02_0056__b1460048175115322">hour:minute</strong>, indicating that the time ranges from 0:00 to 23:59.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row7405105118211"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.6.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p126333415281">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.6.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p2063344114284">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.6.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p863364112819">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.6.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p2633174117282">End time of a resource plan. The value is in the same format as that of <span class="parmname" id="mrs_02_0056__parmname10531629194113"><b>start_time</b></span>. The interval between <strong id="mrs_02_0056__b13597294416">end_time</strong> and <strong id="mrs_02_0056__b759729154115">start_time</strong> must be greater than or equal to 30 minutes.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row19532851132116"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.6.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p206334415288">min_capacity</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.6.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p2633184112285">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.6.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p116331241202817">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.6.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p6633141102810">Minimum number of the preserved nodes in a node group in a resource plan.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p3629135317296">Value range: 0 to 500</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row176245516217"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.6.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p263304119287">max_capacity</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.6.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p146331041172818">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.6.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p156331241162818">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.6.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p19633174118288">Maximum number of the preserved nodes in a node group in a resource plan.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p16373013020">Value range: 0 to 500</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="mrs_02_0056__tefd2eb7c7838496eadbf4b310193de4a"></a><a name="tefd2eb7c7838496eadbf4b310193de4a"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0056__tefd2eb7c7838496eadbf4b310193de4a" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="mrs_02_0056__b1293379065115322">exec_script</strong> parameter description</caption><thead align="left"><tr id="mrs_02_0056__en-us_topic_0264280076_row1428214111224"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.7.2.5.1.1"><p id="mrs_02_0056__en-us_topic_0264280076_p15297171172210"><strong id="mrs_02_0056__b1906909325">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.7.2.5.1.2"><p id="mrs_02_0056__en-us_topic_0264280076_p8318816229"><strong id="mrs_02_0056__b1971545760">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.7.2.5.1.3"><p id="mrs_02_0056__en-us_topic_0264280076_p19332191122219">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.7.2.5.1.4"><p id="mrs_02_0056__en-us_topic_0264280076_p934614122220"><strong id="mrs_02_0056__b741990844">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0056__en-us_topic_0264280076_row16364151162210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.7.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p2716626113010">name</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p9716122653011">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p12716172613308">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.7.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p1271632643011">Name of a custom automation script. It must be unique in a same cluster.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p971662623010">The value can contain only digits, letters, spaces, hyphens (-), and underscores (_) and must not start with a space.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p2716192613010">The value can contain 1 to 64 characters.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row1446317117222"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.7.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p1671632619307">uri</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p771612265306">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p37169268302">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.7.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p15716132603020">Path of a custom automation script. Set this parameter to an OBS bucket path or a local VM path.</p>
<ul id="mrs_02_0056__en-us_topic_0264280076_ul2716122616303"><li id="mrs_02_0056__en-us_topic_0264280076_li1771652616302">OBS bucket path: Enter a script path manually. for example, <strong id="mrs_02_0056__b1545453391115322">s3a://</strong><em id="mrs_02_0056__i123926432115322">XXX</em><strong id="mrs_02_0056__b1907566190115322">/scale.sh</strong>.</li><li id="mrs_02_0056__en-us_topic_0264280076_li13305023118">Local VM path: Enter a script path. The script path must start with a slash (/) and end with <strong id="mrs_02_0056__b230934081115322">.sh</strong>.</li></ul>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row25607102210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.7.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p361414413374">parameters</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p361484123715">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p146149414371">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.7.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p8614746374">Parameters of a custom automation script.</p>
<ul id="mrs_02_0056__en-us_topic_0264280076_ul19405172713813"><li id="mrs_02_0056__en-us_topic_0264280076_li54051027163819">Multiple parameters are separated by space.</li><li id="mrs_02_0056__en-us_topic_0264280076_li5405112723817">The following predefined system parameters can be transferred:<ul id="mrs_02_0056__en-us_topic_0264280076_ul740512275389"><li id="mrs_02_0056__en-us_topic_0264280076_li1540522716388"><em id="mrs_02_0056__i1744206475115322">${mrs_scale_node_num}</em>: Number of the nodes to be added or removed</li><li id="mrs_02_0056__en-us_topic_0264280076_li13405192712388"><em id="mrs_02_0056__i1819884723115322">${mrs_scale_type}</em>: Scaling type. The value can be <strong id="mrs_02_0056__b1449155764115322">scale_out</strong> or <strong id="mrs_02_0056__b2004568615115322">scale_in</strong>.</li><li id="mrs_02_0056__en-us_topic_0264280076_li2405142719388"><em id="mrs_02_0056__i1040698693115322">${mrs_scale_node_hostnames}</em>: Host names of the nodes to be added or removed</li><li id="mrs_02_0056__en-us_topic_0264280076_li104051427173812"><em id="mrs_02_0056__i1040884156115322">${mrs_scale_node_ips}</em>: IP addresses of the nodes to be added or removed</li><li id="mrs_02_0056__en-us_topic_0264280076_li240519271388"><em id="mrs_02_0056__i1131461880115322">${mrs_scale_rule_name}</em>: Name of the rule that triggers auto scaling</li></ul>
</li><li id="mrs_02_0056__en-us_topic_0264280076_li13405102710382">Other user-defined parameters are used in the same way as those of common shell scripts. Parameters are separated by space.</li></ul>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row870514172210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.7.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p106161244377">nodes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p661616418371">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p14616244375">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.7.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p56161649373">Type of a node where the custom automation script is executed. The node type can be Master, Core, or Task.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row67891315228"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.7.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p1733982111374">active_master</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p153391921173710">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p4339142163715">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.7.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p833952163716">Whether the custom automation script runs only on the active Master node.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p13391218375">The default value is <strong id="mrs_02_0056__b731240817115322">false</strong>, indicating that the custom automation script can run on all Master nodes.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row3891131122219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.7.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p195951338133710">action_stage</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p1759563815377">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p195951038123720">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.7.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p5595438133717">Time when a script is executed.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p175951038193717">The following four options are supported:</p>
<ul id="mrs_02_0056__en-us_topic_0264280076_ul959511385379"><li id="mrs_02_0056__en-us_topic_0264280076_li1159543863710"><strong id="mrs_02_0056__b543844261115322">before_scale_out</strong>: before scale-out</li><li id="mrs_02_0056__en-us_topic_0264280076_li175952388373"><strong id="mrs_02_0056__b1077675103115322">before_scale_in</strong>: before scale-in</li><li id="mrs_02_0056__en-us_topic_0264280076_li1159513873719"><strong id="mrs_02_0056__b1207025987115322">after_scale_out</strong>: after scale-out</li><li id="mrs_02_0056__en-us_topic_0264280076_li13595183823719"><strong id="mrs_02_0056__b1399004213115322">after_scale_in</strong>: after scale-in</li></ul>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row173493683712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.7.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p1595838193720">fail_action</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p1595138123712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.7.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p159611387376">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.7.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_p959633833712">Whether to continue to execute subsequent scripts and create a cluster after the custom automation script fails to be executed.</p>
<ul id="mrs_02_0056__en-us_topic_0264280076_ul1859673813372"><li id="mrs_02_0056__en-us_topic_0264280076_li5596183873720"><strong id="mrs_02_0056__b2132134130115322">continue</strong>: Continue to execute subsequent scripts.</li><li id="mrs_02_0056__en-us_topic_0264280076_li1596153883712"><strong id="mrs_02_0056__b1010303589115322">errorout</strong>: Stop the action.<div class="note" id="mrs_02_0056__en-us_topic_0264280076_note1637813387373"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="mrs_02_0056__en-us_topic_0264280076_ul117517425369"><li id="mrs_02_0056__en-us_topic_0264280076_li5751204215360">You are advised to set this parameter to <strong id="mrs_02_0056__b1121060746115322">continue</strong> in the commissioning phase so that the cluster can continue to be installed and started no matter whether the custom automation script is executed successfully.</li><li id="mrs_02_0056__en-us_topic_0264280076_li10592144173612">The scale-in operation cannot be undone. Therefore, <span class="parmname" id="mrs_02_0056__en-us_topic_0264280076_parmname47251253810"><b>fail_action</b></span> must be set to <span class="parmvalue" id="mrs_02_0056__en-us_topic_0264280076_parmvalue7529192612381"><b>continue</b></span> for the scripts that are executed after scale-in.</li></ul>
</div></div>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="mrs_02_0056__t46230cdbc4f641f6b17d64de5747728b"></a><a name="t46230cdbc4f641f6b17d64de5747728b"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0056__t46230cdbc4f641f6b17d64de5747728b" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="mrs_02_0056__b365852576115322">rules</strong> parameter description</caption><thead align="left"><tr id="mrs_02_0056__en-us_topic_0264280076_r04dab5da98994243b13ab537426a3a97"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.8.2.5.1.1"><p id="mrs_02_0056__en-us_topic_0264280076_ad679ccb275b24cc496175d3841c71d4a"><strong id="mrs_02_0056__b1224657369">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.8.2.5.1.2"><p id="mrs_02_0056__en-us_topic_0264280076_a640760dee401468b9b46729570e2c885"><strong id="mrs_02_0056__b1471264248">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.8.2.5.1.3"><p id="mrs_02_0056__en-us_topic_0264280076_acb08948a5f1440c3b9925d7b25fd1cfc">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.8.2.5.1.4"><p id="mrs_02_0056__en-us_topic_0264280076_ae3354bfaa9f549358e263c7ff419fb0b"><strong id="mrs_02_0056__b1842599293">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0056__en-us_topic_0264280076_rb70a6fabcd634bb488830fad4df3ec23"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.8.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a30a512ec6a824430b85d412a03a87f01">name</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a9821fa2ef3a545c6918722356913f19d">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a79be49bbaf734f838a223ef00e505777">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.8.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_aba48112f6b6643379185e9024b158818">Name of an auto scaling rule.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_ad2dfd75a61e449daba07a8aec95b70af">A cluster name can contain only 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a4fb8ccd95fd84f4e9167a742ea119278">Rule names must be unique in a node group.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r43e582bae8d7452ba656dde618f5200c"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.8.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a4db367e43bb943eeb5a845fa7b3209a6">description</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_aa3ce5a5274894b5c8ff040dbda4d893a">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a5229ef45bcb04550a546ed9ef4541966">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.8.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_a54e73e7a5fe84ea68e0c68c676c69078">Description about an auto scaling rule.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a3913d07fc617486c800f3e34ebc28224">It contains a maximum of 1,024 characters.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r63d765b129664dad957626f380819572"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.8.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a44f544e08b0a41de95dabf9bf4e1434a">adjustment_type</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_aeef54466240a420aa0b5613dbb65143d">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a433b89c3fb244d7e954a41597d978cf8">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.8.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_afb3bb8888f944246b9b844cf271c4ab2">Auto scaling rule adjustment type. The options are as follows:</p>
<ul id="mrs_02_0056__en-us_topic_0264280076_u18ec9abfa0234393b376df8ff616d19b"><li id="mrs_02_0056__en-us_topic_0264280076_l81d5baf4a2a44b92856c44501da9d358"><strong id="mrs_02_0056__b459211210115322">scale_out</strong>: cluster scale-out</li><li id="mrs_02_0056__en-us_topic_0264280076_ld8f628f40c1040e98a2184d5bc217035"><strong id="mrs_02_0056__b1119236775115322">scale_in</strong>: cluster scale-in</li></ul>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r6f9ebcd76459417a908a73ec838efe7c"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.8.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a8f20410dbaee433abb560ec4458140af">cool_down_minutes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_ace0d1386b05a420fad2f53bd4dbd7f4f">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a125498882f804fa99362663be962a9ec">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.8.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_a962e8faec9684b4b9388ddaae5f20f25">Cluster cooling time after an auto scaling rule is triggered, when no auto scaling operation is performed. The unit is minute.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a934200a982984f90a54b157715b28542">Value range: 0 to 10,080. One week is equal to 10,080 minutes.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r83dc95f88c514f349fe399e2daec1acf"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.8.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a1bf156eb290c4eacac485c8e69bb9b8a">scaling_adjustment</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_ac34a827ef47d41c19cb0a362521c1749">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a8ed38e14158144d1a1feee5d0c6672f9">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.8.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_acf6914ca275e493ba883ebb8a607a1ad">Number of nodes that can be adjusted once.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a665de6492d5f41e183c5fdfa2a65629a">Value range: 1 to 100</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r66369f0421994b56a9ed58368cc08d5a"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.8.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a5817b59eda8846d1ae9d530bd1ab342d">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_aee6e5978de8143a7bfdc40db6e9304b2">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.8.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_afd9beb4a2ace493390bc25ced1fecf8d">Trigger</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.8.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_a2c60fdaa8e8b434d91a9aaf1e369eff6">Condition for triggering a rule. For details, see <a href="#mrs_02_0056__tb0fcdad7ce8f4ebdb4fd9e76d805b5e8">Table 7</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="mrs_02_0056__tb0fcdad7ce8f4ebdb4fd9e76d805b5e8"></a><a name="tb0fcdad7ce8f4ebdb4fd9e76d805b5e8"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0056__tb0fcdad7ce8f4ebdb4fd9e76d805b5e8" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="mrs_02_0056__b126300743115322">trigger</strong> parameter description</caption><thead align="left"><tr id="mrs_02_0056__en-us_topic_0264280076_rff8c363cdf464eb5a3a11207ffdf1cd8"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.9.2.5.1.1"><p id="mrs_02_0056__en-us_topic_0264280076_af7ff5d0628724b4fa7b5cf884ea1b773"><strong id="mrs_02_0056__b590084413">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.9.2.5.1.2"><p id="mrs_02_0056__en-us_topic_0264280076_a56f9bf71c2fc47b5a8e8e7c679965679"><strong id="mrs_02_0056__b941802929">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.9.2.5.1.3"><p id="mrs_02_0056__en-us_topic_0264280076_a8933d7f27ddb4c9798f80813eb864963">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.9.2.5.1.4"><p id="mrs_02_0056__en-us_topic_0264280076_a1f9301595b084bb0a1226a00ef63cf3a"><strong id="mrs_02_0056__b773865119">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0056__en-us_topic_0264280076_re14becd52b854699886dab346ddbbca9"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.9.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_ad3f42958ab364805946248b8a97a5681">metric_name</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.9.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a5e62e69cca49432484b604bd6c10da4f">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.9.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_af5d60c6023c64eb3af69213451e45a08">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.9.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_a67c5bbe2340144a0ac4ae630da919fdb">Metric name.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_ad6898742fd8c4b3d90f62a110092174a">This triggering condition makes a judgment according to the value of the metric.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_adb15d44ef9cd49719e1558f955af8fe0">A metric name contains a maximum of 64 characters.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a249e5e0f422a474eb818f01e56c3c6e2"><a href="#mrs_02_0056__td49a8d90c5444d929b277b709d35c445">Table 8</a> lists the supported metric names.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_rdf8d159ee61f4397920756d6db18f225"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.9.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_aaefe5f406be947a9bc590420af9fa60a">metric_value</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.9.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_ad6ce5627219640d1a928ec145a5c9543">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.9.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_ae5eed36b433c4a778931e35c51c255c0">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.9.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_af6f48d7468d64a0394a3a4213d2a2268">Metric threshold to trigger a rule</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a9cb6280b4c514776b95dd786fe3b71b9">The parameter value must be an integer or number with two decimal places only. <a href="#mrs_02_0056__td49a8d90c5444d929b277b709d35c445">Table 8</a> provides value types and ranges corresponding to <strong id="mrs_02_0056__b398433437115322">metric_name</strong>.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_re4671e894e4448eb87e9d7ff852aecb5"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.9.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_af47cf271b63941ac96944f24e87910b2">comparison_operator</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.9.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_ab55411f4b2a54e7195864b2dc799f3bb">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.9.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a933e80262e8c483dbfbf38aa2ec35333">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.9.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_adf4bb9d515db4212bee56e7a4389a892">Metric judgment logic operator. The options are as follows:</p>
<ul id="mrs_02_0056__en-us_topic_0264280076_u7169b3049e9342e185a5074148528db2"><li id="mrs_02_0056__en-us_topic_0264280076_l13c981ce21224f819f878980b4fed42a"><strong id="mrs_02_0056__b330807804115322">LT</strong>: less than</li><li id="mrs_02_0056__en-us_topic_0264280076_lcc7e6b1462834f3e815643afc36f44c1"><strong id="mrs_02_0056__b1752199778115322">GT</strong>: greater than</li><li id="mrs_02_0056__en-us_topic_0264280076_l1b37bddaae0849138262f4a5b45bde3e"><strong id="mrs_02_0056__b683334424115322">LTOE</strong>: less than or equal to</li><li id="mrs_02_0056__en-us_topic_0264280076_l5d7813f50b03478ca9060afa7af9a4f4"><strong id="mrs_02_0056__b931546846115322">GTOE</strong>: greater than or equal to</li></ul>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_rf50d0c4b959f434f956a9cd587368b68"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.9.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a03c9f551658b4130989f42292477ab3a">evaluation_periods</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.9.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a036fbc2365fe431f9752b41bf56b6913">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.9.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_aaf1bc273e1ea46b3bd11b243b4223b90">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.9.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_aac0eda51209e440da2832133da986fe2">Number of consecutive five-minute periods, during which a metric threshold is reached</p>
<p id="mrs_02_0056__en-us_topic_0264280076_ab1eaebbe8f6a4f64ba521a9e4558f4b4">Value range: 1 to 288</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="mrs_02_0056__td49a8d90c5444d929b277b709d35c445"></a><a name="td49a8d90c5444d929b277b709d35c445"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0056__td49a8d90c5444d929b277b709d35c445" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Auto scaling metrics</caption><thead align="left"><tr id="mrs_02_0056__en-us_topic_0264280076_r6f513581428249f08e517a602d698e15"><th align="left" class="cellrowborder" valign="top" width="15.598440155984402%" id="mcps1.3.3.10.2.5.1.1"><p id="mrs_02_0056__en-us_topic_0264280076_a438235aa61f14211bfc4a1a5b83eb558">Cluster Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.437556244375564%" id="mcps1.3.3.10.2.5.1.2"><p id="mrs_02_0056__en-us_topic_0264280076_abe5e348bbff341ce8105e23a1ed1773b">Metric</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.22847715228477%" id="mcps1.3.3.10.2.5.1.3"><p id="mrs_02_0056__en-us_topic_0264280076_a682d9e227f744055822e498bf9c5856d">Value Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.73552644735527%" id="mcps1.3.3.10.2.5.1.4"><p id="mrs_02_0056__en-us_topic_0264280076_a253484a6f10b4e48932213cd57a12322"><strong id="mrs_02_0056__b254262640">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0056__en-us_topic_0264280076_r3d35885bfaf34dd19a45669ca955ca07"><td class="cellrowborder" rowspan="7" valign="top" width="15.598440155984402%" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a5114f66cbef24be89bf81e8698e641bf">Streaming cluster</p>
</td>
<td class="cellrowborder" valign="top" width="24.437556244375564%" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_ac72545b57c754656979548eb610a6870">StormSlotAvailable</p>
</td>
<td class="cellrowborder" valign="top" width="15.22847715228477%" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a335961e130ae43bbad38525916ff3c50">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="44.73552644735527%" headers="mcps1.3.3.10.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_a6798fd17f81446d7bc23b65c206e62df">Number of available Storm slots.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_af8a8f569acf143b1b0641749d9a8958c">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_rb933f33ebd4043ba9e917d0d2f4852e3"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_ab02fb123f43e415b8bb10a908a8acb3b">StormSlotAvailablePercentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a52893a2e940f4c5ab48c2e5473ce2f0a">Percentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a019e6f8ac83a4aa88544fb69ef775a38">Percentage of available Storm slots, that is, the proportion of the available slots to total slots.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_ac2fa579fd8b34e32bee870e7fc7f2ac9">Value range: 0 to 100.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r08070c64771a42b6a113d6febbfaa29d"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a691509a26b894eb482bc9ba4b595edb1">StormSlotUsed</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_abe031b1f053a4e3ead22c147dcafa3aa">Integer</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a277ae72eb6754de2bf11608cd9e6e12e">Number of the used Storm slots.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_ae765f078f7354dacb24c79349c9a5e6c">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_re0b727e5886646b49fe255ac2e7a2951"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_afd137ca4d82b4bceb58798293de6c8d4">StormSlotUsedPercentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a880db12e66534c39810fd1d0bd16093a">Percentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_ad49e3d813f2d4239a469338f348c3077">Percentage of the used Storm slots, that is, the proportion of the used slots to total slots.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_ada4c81170b0d4b93b744a65a698d5174">Value range: 0 to 100.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row177919386154"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p135088571721">StormSupervisorMemAverageUsage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p1950845719217">Integer</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p165082571219">Average memory usage of the Supervisor process of Storm.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p165194141793">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row631194414155"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p188210636">StormSupervisorMemAverageUsagePercentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p6821801732">Percentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p88213018314">Average percentage of the used memory of the Supervisor process of Storm to the total memory of the system.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p3227151918108">Value range: 0 to 100.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_row7783194871512"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_p794819218319">StormSupervisorCPUAverageUsagePercentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_p1494842533">Percentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_p1948121837">Average percentage of the used CPUs of the Supervisor process of Storm to the total CPUs.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_p1690164451113">Value range: 0 to 6000.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_ra430378d169b44c29d0139187c0f4a11"><td class="cellrowborder" rowspan="14" valign="top" width="15.598440155984402%" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_af2c3361bef3e4acda820a0b5349dab94">Analysis cluster</p>
</td>
<td class="cellrowborder" valign="top" width="24.437556244375564%" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a2ebc162d44404c4b9171628d2937cac6">YARNAppPending</p>
</td>
<td class="cellrowborder" valign="top" width="15.22847715228477%" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a49aea79e2e884b39906752aeb50f6a38">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="44.73552644735527%" headers="mcps1.3.3.10.2.5.1.4 "><p id="mrs_02_0056__en-us_topic_0264280076_ad5b596886c494b288346f643daa764e9">Number of pending tasks on Yarn.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a35def1222c304e88a59b86583ce0130d">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r1c774463d2a14083a7fdfd96cbaefcef"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a26a74b6270f741a09b3bc5dec2b8a129">YARNAppPendingRatio</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a8867793be2584544838efdc864b1b199">Ratio</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a16e41ae39c3542cea4823cc61c96a5d3">Ratio of pending tasks on Yarn, that is, the ratio of pending tasks to running tasks on Yarn.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a2d50ce28b3f445d49825f72dd917624d">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_ra094fb90825148839fb3e3c750b09969"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_aa9ba37f3d402455d8e6f9d17b3b83329">YARNAppRunning</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a985a37b47e8541daa74672ec40190b2d">Integer</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_ab56444e8f8054590a8eb9776184ee285">Number of running tasks on Yarn.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a6bb7fc15c9cc497b9befea371482ee14">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r877ab3607fb24199a4f8f5e6027e2d83"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a5e1a1fcebf9c4f5f96457b335d8d3524">YARNContainerAllocated</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a4582c276628b40d69800e7c2f0f3e496">Integer</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a8dd055b550404e3586a2d008b49cb4aa">Number of containers allocated to Yarn.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a0af753d126374689b243d324b8b62643">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_rf899d1058342458c8922fce992d570cc"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a3c879e53204943baa6f00e332603b436">YARNContainerPending</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a9a4b0bf584494168ad484b62945df5ab">Integer</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_abd01e06bb70544e38882c07fdf1e5fbe">Number of pending containers on Yarn.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a93d072fada4a4322bb38029de44e1ea2">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r6eea766caaa8483ba2889235d08f1fb1"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a554108d1a4ac4d548d0d7c913d2c0e96">YARNContainerPendingRatio</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a2f421b01c38b4dacab515d5013a94ec6">Ratio</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a3ff2b486a44e4a079f2893a62ebe1057">Ratio of pending containers on Yarn, that is, the ratio of pending containers to running containers on Yarn.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_afbecb57893244882aa592c19c2c6d4ca">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_rada32b2ffd544cdb9aceb4f9499866c0"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_aa85783e97d85436eaf8172c7a9377839">YARNCPUAllocated</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_ae9db170af0a74db097a4118d3c6acbd5">Integer</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a83a9e1639ef541398ad1326edfbe5652">Number of virtual CPUs (vCPUs) allocated to Yarn</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a647834b124bd4911a4e811ad0d5fab4e">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r24f9d8b6e19347a6af3a2b2602817b67"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a56f523a1e5d3450bbfdda7743eb92854">YARNCPUAvailable</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a1879208a01884bc3bd21a4d2c696aad8">Integer</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a0ae5d086156342deba2460f41206c148">Number of available vCPUs on Yarn.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_aee8087bc3ad8436fa0f8ef040ba673ab">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_rb1a623bacb3446a7ad80947e61db5e14"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a14553be3cec14ae38983fbfb99f29d83">YARNCPUAvailablePercentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a4ba6a334b5624002aea5c16ec2bef623">Percentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a7f11c0314e0d4bcba94eaf62b670b6f1">Percentage of available vCPUs on Yarn, that is, the proportion of available vCPUs to total vCPUs.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a50104756cbae4a11afe22dfe9b28fd26">Value range: 0 to 100.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r0d968a43dce44f34bc59e65763a42dff"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_aaf82b0df6bd1489b9e4835f72e66848b">YARNCPUPending</p>
<p id="mrs_02_0056__en-us_topic_0264280076_adb1ad1fe51bc4d9097f76ed15949faee"></p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a182e236f3a6547c1b0c9ddeedc1cb812">Integer</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a091982b0354948558a83a2972fc10d78">Number of pending vCPUs on Yarn.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a28c518ff6e6f4720a9f248b1785b1a2b">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r07797e16294f41f2bd22c3d3e0f4fd86"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_af491e04ac4c749678edb5ccd96ecad9c">YARNMemoryAllocated</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_ab2771fecf43a4a048713d458958feac6">Integer</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_ab22cfcbebf544c61b8dc9284e58cf92a">Memory allocated to Yarn. The unit is MB.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a482cb09ec7f146e997111e48c2165fad">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_re4224e170a464ddcb72136c05158e75b"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_a2e28017342644f3eb52611d00003d7b7">YARNMemoryAvailable</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_ab709decebd9e4b69a20482fd11472034">Integer</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a561342c4dfc44654a5ea5ebfcb97c989">Available memory on Yarn. The unit is MB.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_abfa4f9cfe2094a23b33bdd2f66070f57">Value range: 0 to 2147483646.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_refec09246ff047d7a9e3bf7d06a42cfd"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_aaa3390f6e15d4e5ea1140e5d599e6035">YARNMemoryAvailablePercentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a67ac734ecc7b4b018a960953697740ed">Percentage</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_ac111dffe2233485382eab7979f3b65b3">Percentage of available memory on Yarn, that is, the proportion of available memory to total memory on Yarn.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_ae0f790dfccb9435484818f104234f1ea">Value range: 0 to 100.</p>
</td>
</tr>
<tr id="mrs_02_0056__en-us_topic_0264280076_r0c96fd2f38dc41c6abb55f6997c2f4ad"><td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.1 "><p id="mrs_02_0056__en-us_topic_0264280076_af44c9409613840b281cd58f04122b5f8">YARNMemoryPending</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.2 "><p id="mrs_02_0056__en-us_topic_0264280076_a462b3630c14b4fdcb4fbeabe4d5767cb">Integer</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.10.2.5.1.3 "><p id="mrs_02_0056__en-us_topic_0264280076_a4a7656ef0e7d41e994bb809330d24e1f">Pending memory on Yarn.</p>
<p id="mrs_02_0056__en-us_topic_0264280076_a5a450cbc34414ab599f331078b5f7d88">Value range: 0 to 2147483646.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="mrs_02_0056__ndb6698f41b424bb0897aec6e6a80cd12"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="mrs_02_0056__en-us_topic_0264280076_af3214f6e277f436b90b2c7c3cc9aa758">When the value type is percentage or ratio in <a href="#mrs_02_0056__td49a8d90c5444d929b277b709d35c445">Table 8</a>, the valid value can be accurate to percentile. The percentage metric value is a decimal value with a percent sign (%) removed. For example, 16.80 represents 16.80%.</p>
</div></div>
</div>
<div class="section" id="mrs_02_0056__section38599577193858"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0056__table8319691114112" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_0056__row39824979114112"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.1"><p id="mrs_02_0056__p4597879114112"><strong id="mrs_02_0056__b9293634164919">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.2"><p id="mrs_02_0056__p34804503114112"><strong id="mrs_02_0056__b12817153744911">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.2.4.1.3"><p id="mrs_02_0056__p592484114112"><strong id="mrs_02_0056__b1753564953">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0056__row47991225114112"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0056__p62084031114112">result</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0056__p44067044114112">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0056__p12660774114112">Operation result</p>
<ul id="mrs_02_0056__ul46838108114112"><li id="mrs_02_0056__li18889789114112">succeeded: The operation is successful.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="mrs_02_0056__section1210015461189"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0056__ul1958913536182"><li id="mrs_02_0056__li1558945321814">Example request<pre class="screen" id="mrs_02_0056__screen36575968141836">{
"node_group":"task_node_default_group",
"auto_scaling_policy": {
"auto_scaling_enable": true,
"min_capacity": "1",
"max_capacity": "3",
"resources_plans": [{
"period_type": "daily",
"start_time": "9:50",
"end_time": "10:20",
"min_capacity": "2",
"max_capacity": "3"
},{
"period_type": "daily",
"start_time": "10:20",
"end_time": "12:30",
"min_capacity": "0",
"max_capacity": "2"
}],
"exec_scripts": [{
"name": "before_scale_out",
"uri": "s3a://XXX/zeppelin_install.sh",
"parameters": "",
"nodes": [
"master",
"core",
"task"
],
"active_master": "true",
"action_stage": "before_scale_out",
"fail_action": "continue"
},{
"name": "after_scale_out",
"uri": "s3a://XXX/storm_rebalance.sh",
"parameters": "",
"nodes": [
"master",
"core",
"task"
],
"active_master": "true",
"action_stage": "after_scale_out",
"fail_action": "continue"
}],
"rules": [{
"name": "default-expand-1",
"adjustment_type": "scale_out",
"cool_down_minutes": 5,
"scaling_adjustment": 1,
"trigger": {
"metric_name": "YARNMemoryAvailablePercentage",
"metric_value": "25",
"comparison_operator": "LT",
"evaluation_periods": 10
}
},
{
"name": "default-shrink-1",
"adjustment_type": "scale_in",
"cool_down_minutes": 5,
"scaling_adjustment": 1,
"trigger": {
"metric_name": "YARNMemoryAvailablePercentage",
"metric_value": "70",
"comparison_operator": "GT",
"evaluation_periods": 10
}
}]
}
}</pre>
<div class="note" id="mrs_02_0056__note22219425143048"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="mrs_02_0056__p25896569143057">A new auto scaling rule will overwrite the auto scaling rule saved in the original database. If you want to modify the original rule, query the original rule first, modify the rule, and submit a modification task. For details, see <a href="mrs_02_0031.html">Querying Cluster Details</a>.</p>
</div></div>
</li><li id="mrs_02_0056__li543710159193">Example response<pre class="screen" id="mrs_02_0056__screen811664518503">{ "result": "succeeded" }</pre>
</li></ul>
</div>
<div class="section" id="mrs_02_0056__section56352013105226"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0056__p1884975610328"><a href="#mrs_02_0056__table5043525610328">Table 10</a> describes the status code of this API.</p>
<div class="tablenoborder"><a name="mrs_02_0056__table5043525610328"></a><a name="table5043525610328"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0056__table5043525610328" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Status code</caption><thead align="left"><tr id="mrs_02_0056__row1549446910328"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.3.2.3.1.1"><p id="mrs_02_0056__p4709251510328"><strong id="mrs_02_0056__b1022570061">Status Code</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.3.2.3.1.2"><p id="mrs_02_0056__p5639738110328"><strong id="mrs_02_0056__b815133566">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0056__row478517210328"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.3.2.3.1.1 "><p id="mrs_02_0056__p5205464710328">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.3.2.3.1.2 "><p id="mrs_02_0056__p5567688710328">The cluster has been successfully created.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="mrs_02_0056__p1877104775313">For the description about error status codes, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0054.html">Auto Scaling APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink