配置弹性伸缩规则

node_group

是

String

参数解释：

弹性伸缩规则适用的节点类型，当前只支持Task节点。

约束限制：

不涉及

取值范围：

• task_node_default_group：弹性伸缩规则适用Task节点。

默认取值：

不涉及

auto_scaling_policy

是

AutoScalingPolicy object

参数解释：

弹性伸缩规则。详细参数说明请参考表3。

约束限制：

不涉及

auto_scaling_enable

是

Boolean

参数解释：

当前自动伸缩规则是否开启。

约束限制：

不涉及

取值范围：

• true：开启自动伸缩规则。
• false：不开启自动伸缩规则。

默认取值：

不涉及

min_capacity

是

Integer

参数解释：

指定该节点组的最小保留节点数。

约束限制：

不涉及

取值范围：

0-500

默认取值：

不涉及

max_capacity

是

Integer

参数解释：

指定该节点组的最大节点数。

约束限制：

不涉及

取值范围：

0-500

默认取值：

不涉及

resources_plans

否

List

参数解释：

资源计划列表，详细说明请参见表4。若该参数为空表示不启用资源计划。

约束限制：

当启用弹性伸缩时，资源计划与自动伸缩规则需至少配置其中一种。

exec_scripts

否

List

参数解释：

弹性伸缩自定义自动化脚本列表。详细说明请参见表5。若该参数为空表示不启用钩子脚本。

约束限制：

不能超过10条。

rules

否

List

参数解释：

自动伸缩的规则列表，详细说明请参见表6。

约束限制：

当启用弹性伸缩时，资源计划与自动伸缩规则需至少配置其中一种。不能超过10条。

period_type

是

String

参数解释：

资源计划的周期类型，当前只允许以下类型：daily。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

start_time

是

String

参数解释：

资源计划的起始时间。格式为“hour:minute”，表示时间在0:00-23:59之间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

end_time

是

String

参数解释：

资源计划的结束时间，格式与“start_time”相同。

约束限制：

不早于start_time表示的时间，且与start_time间隔不小于30min。

取值范围：

不涉及

默认取值：

不涉及

min_capacity

是

Integer

参数解释：

资源计划内该节点组的最小保留节点数。

约束限制：

不涉及

取值范围：

0-500

默认取值：

不涉及

max_capacity

是

Integer

参数解释：

资源计划内该节点组的最大保留节点数。

约束限制：

不涉及

取值范围：

0-500

默认取值：

不涉及

name

是

String

参数解释：

弹性伸缩自定义自动化脚本的名称。

约束限制：

不涉及

取值范围：

同一个集群的自定义自动化脚本名称不允许相同。

只能由数字、英文字符、空格、中划线和下划线组成，且不能以空格开头。

可输入的字符串长度为1～64个字符。

默认取值：

不涉及

uri

是

String

参数解释：

自定义自动化脚本的路径。设置为OBS桶的路径或虚拟机本地的路径。

• OBS桶的路径：直接手动输入脚本路径。示例：s3a://XXX/scale.sh
• 虚拟机本地的路径：用户需要输入正确的脚本路径。脚本所在的路径必须以‘/’开头，以.sh结尾。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

parameters

否

String

参数解释：

自定义自动化脚本参数。

• 多个参数间用空格隔开。
• 可以传入以下系统预定义参数：
  • ${mrs_scale_node_num}：扩缩容节点数
  • ${mrs_scale_type}：扩缩容类型，扩容为scale_out，缩容为scale_in
  • ${mrs_scale_node_hostnames}：扩缩容的节点主机名称
  • ${mrs_scale_node_ips}：扩缩容的节点IP
  • ${mrs_scale_rule_name}：触发扩缩容的规则名
• 其他用户自定义参数使用方式与普通shell脚本相同，多个参数中间用空格隔开。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

nodes

是

Array of strings

参数解释：

自定义自动化脚本所执行的节点类型，包含Master、Core和Task三种类型。

约束限制：

不涉及

active_master

否

Boolean

参数解释：

自定义自动化脚本是否只运行在主Master节点上。

约束限制：

不涉及

取值范围：

• true：自定义自动化脚本只运行在主Master节点上。
• false：自定义自动化脚本可运行在所有Master节点上。

默认取值：

false

action_stage

是

String

参数解释：

脚本执行时机。

约束限制：

不涉及

取值范围：

• before_scale_out：扩容前
• before_scale_in：缩容前
• after_scale_out：扩容后
• after_scale_in：缩容后

默认取值：

不涉及

fail_action

是

String

参数解释：

自定义自动化脚本执行失败后，是否继续执行后续脚本和创建集群。

约束限制：

不涉及

取值范围：

• continue：继续执行后续脚本。
• errorout：终止操作。

默认取值：

不涉及

name

是

String

参数解释：

弹性伸缩规则的名称。

约束限制：

不涉及

取值范围：

只能由字母、数字、中划线和下划线组成，并且长度为1～64个字符。

在一个节点组范围内，不允许重名。

默认取值：

不涉及

description

否

String

参数解释：

弹性伸缩规则的说明。

约束限制：

不涉及

取值范围：

长度小于等于1024个字符。

默认取值：

不涉及

adjustment_type

是

String

参数解释：

弹性伸缩规则的调整类型。

约束限制：

不涉及

取值范围：

• scale_out：扩容
• scale_in：缩容

默认取值：

不涉及

cool_down_minutes

是

Integer

参数解释：

触发弹性伸缩规则后，该集群处于冷却状态（不再执行弹性伸缩操作）的时长，单位为分钟。

约束限制：

不涉及

取值范围：

0～10080，10080为一周的分钟数。

默认取值：

不涉及

scaling_adjustment

是

Integer

参数解释：

单次调整集群节点的个数。

约束限制：

不涉及

取值范围：

1-100

默认取值：

不涉及

trigger

是

Trigger object

参数解释：

描述该规则触发条件，详细说明请参见表7。

约束限制：

不涉及

metric_name

是

String

参数解释：

指标名称。

该触发条件会依据该名称对应指标的值来进行判断。

约束限制：

不涉及

取值范围：

长度最大为64个字符。

默认取值：

不涉及

metric_value

是

String

参数解释：

指标阈值。

触发该条件的指标阈值，只允许输入整数或者带两位小数的数。

约束限制：

不涉及

取值范围：

只允许输入整数或者带两位小数的数。

默认取值：

不涉及

comparison_operator

否

String

参数解释：

指标判断逻辑运算符.

约束限制：

不涉及

取值范围：

• LT：小于
• GT：大于
• LTOE：小于等于
• GTOE：大于等于

默认取值：

不涉及

evaluation_periods

是

Integer

参数解释：

判断连续满足指标阈值的周期数(一个周期为5分钟)。

约束限制：

不涉及

取值范围：

1-200

默认取值：

不涉及

result

String

参数解释：

操作结果。

取值范围：

• succeeded：操作成功。
• 操作失败时返回的错误码信息如错误码所示。

200

创建集群成功。