CreateScalingGroup

系统规定参数。取值：CreateScalingGroup。

伸缩组的名称，同一地域下伸缩组名称唯一。

长度为2~64个英文或中文字符，以数字、大小写英文字母或中文开头，可以包含数字、下划线（_）、短划线（-）和半角句号（.）。

默认值为ScalingGroupId的值。

实例启动模板ID，用于指定伸缩组从实例启动模板获取启动配置信息。

实例启动模板的版本。取值范围：

• 固定的模板版本号。
• Default：始终使用模板默认版本。
• Latest：始终使用模板最新版本。

实例的ID。创建伸缩组时，将从指定的实例获取所需的配置信息，并自动创建伸缩配置。

伸缩组所属的地域ID。更多信息，请参见地域与可用区。

伸缩组内实例台数的最小值，当伸缩组内实例数小于MinSize的值时，弹性伸缩会自动创建实例。

伸缩组内实例台数的最大值，当伸缩组内实数大于MaxSize的值时，弹性伸缩会自动移出实例。

MaxSize的取值范围和弹性伸缩使用情况有关，请前往配额中心查看单个伸缩组可以设置的组内最大实例数对应的配额值。

如果单个伸缩组可以设置的组内最大实例数对应的配额值为2000，则MaxSize的取值范围为0~2000。

一次伸缩活动（添加或移出实例）结束后的一段冷却时间。取值范围：0~86400，单位：秒。

冷却时间内，该伸缩组不执行其它的伸缩活动，仅针对云监控报警任务触发的伸缩活动有效。

默认值：300。

传统型负载均衡CLB（原SLB）实例ID。取值可以是由多台CLB实例ID组成一个JSON数组，ID之间用半角逗号（,）隔开。

单个伸缩组可以关联的CLB总数和弹性伸缩使用情况有关，请前往配额中心查看单个伸缩组可以关联的负载均衡实例总数对应的配额值。

RDS实例ID。取值可以是由多台RDS实例ID组成一个JSON数组，ID之间用半角逗号（,）隔开。

单个伸缩组可以关联的RDS实例总数和弹性伸缩使用情况有关，请前往配额中心查看单个伸缩组可以关联的RDS实例总数对应的配额值。

指定实例移出策略的第一段筛选策略。不允许与RemovalPolicy.2和RemovalPolicy.3取值相同。取值范围：

• OldestInstance：移出最早加入伸缩组的ECS实例。
• NewestInstance：移出最新加入伸缩组的ECS实例。
• OldestScalingConfiguration：移出最早伸缩配置创建的ECS实例。
• CustomPolicy：基于自定义缩容策略Function函数移除ECS实例。

OldestScalingConfiguration中提到的伸缩配置泛指组内实例配置信息来源，包括伸缩配置和启动模板。CustomPolicy仅支持设置为首位移出策略，当指定CustomPolicy需同时指定CustomPolicyARN参数。

指定实例移出策略的第二段筛选策略，不允许与RemovalPolicy.1和RemovalPolicy.3取值相同。取值范围：

• OldestInstance：移出最早加入伸缩组的ECS实例。
• NewestInstance：移出最新加入伸缩组的ECS实例。
• OldestScalingConfiguration：移出最早伸缩配置创建的ECS实例。

指定实例移出策略的第三段筛选策略，不允许与RemovalPolicy.1和RemovalPolicy.2取值相同。取值范围：

• OldestInstance：移出最早加入伸缩组的ECS实例。
• NewestInstance：移出最新加入伸缩组的ECS实例。
• OldestScalingConfiguration：移出最早伸缩配置创建的ECS实例。

虚拟交换机的ID。指定后，伸缩组的网络类型为专有网络。

多可用区伸缩组ECS实例扩缩容策略。取值范围：

• PRIORITY：先指定的虚拟交换机（VSwitchIds.N）优先级最高。弹性伸缩优先在优先级最高的交换机所在可用区尝试扩缩容，如果无法扩缩容，则自动在下一优先级的交换机所在可用区进行扩缩容。

• COST_OPTIMIZED：扩容时弹性伸缩按vCPU单价从低到高尝试创建ECS实例，缩容时按vCPU单价从高到低尝试移出ECS实例。当伸缩配置设置了抢占式计费方式的多实例规格时，优先创建对应抢占式实例。您可以继续通过CompensateWithOnDemand参数指定当抢占式实例由于库存等原因无法创建时，是否自动尝试以按量付费的方式创建。

  说明 COST_OPTIMIZED仅在伸缩配置设置了多实例规格或者选用了抢占式实例的情况下生效。

• BALANCE：在伸缩组指定的多可用区之间均匀分配ECS实例。如果由于库存不足等原因可用区之间变得不平衡，您可以通过API RebalanceInstance平衡资源。
• COMPOSABLE：是一种组合策略，您可以根据需要自主组合上述多可用区伸缩组ECS实例的扩缩容策略。或者进一步指定参数，对伸缩组的容量进行更精细地控制。

默认值：PRIORITY。

伸缩组的健康检查方式。取值范围：

• NONE：不做健康检查。
• ECS：对伸缩组内的实例做健康检查（ECS类型和ECI类型的伸缩组均使用本取值开启实例健康检查）。
• LOAD_BALANCER: 根据负载均衡（暂不支持CLB负载均衡类型）健康检查结果判断实例健康状态。

默认值：ECS。

指定伸缩组的回收模式。取值范围：

• recycle：伸缩组的回收模式为停机回收模式。
• release：伸缩组的回收模式为释放模式。

• forcerelease：伸缩组的回收模式为强制释放模式。

  说明 选择forcerelease后，在弹性收缩活动中系统会强制释放运行中（Running）的实例。强制释放实例相当于断电操作，会导致该实例内存以及存储中的临时数据被擦除，数据无法恢复，请您谨慎选择。

• forcerecycle：伸缩组的回收模式为强制停机回收模式。

  说明 选择forcerecycle后，在弹性收缩活动中系统会强制关机运行中（Running）的实例。强制关机相当于断电操作，会导致该实例内存以及存储中的临时数据被擦除，数据无法恢复，请您谨慎选择。

ScalingPolicy指定伸缩组的回收模式，但实例被移出伸缩组时的具体动作，由RemoveInstances的RemovePolicy参数决定，更多信息，请参见RemoveInstances。

保证请求幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。更多信息，请参见如何保证幂等性。

伸缩组所需要按量实例个数的最小值，取值范围：0~1000。当按量实例个数少于该值时，将优先创建按量实例。

当MultiAZPolicy参数取值为COMPOSABLE策略时，默认值为0。

伸缩组满足最小按量实例数（OnDemandBaseCapacity）要求后，超出的实例中按量实例应占的比例，取值范围：0～100。

当MultiAZPolicy参数取值为COMPOSABLE策略时，默认值为100。

是否开启补齐抢占式实例。开启后，当收到抢占式实例将被回收的系统消息时，伸缩组将尝试创建新的实例，替换掉将被回收的抢占式实例。

当MultiAZPolicy取值为COST_OPTIMIZED时，如果因价格、库存等原因无法创建足够的抢占式实例，是否允许自动尝试创建按量实例满足ECS实例数量要求。取值范围：

• true：允许。
• false：不允许。

默认值：true。

指定可用实例规格的个数，伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围：1~10。

当MultiAZPolicy参数取值为COMPOSABLE策略时，默认值为2。

伸缩组内ECS实例的期望数量，伸缩组会自动将ECS实例数量维持在期望实例数。取值不得大于MaxSize，且不得小于MinSize。

是否开启伸缩组删除保护。取值范围：

• true：开启伸缩组删除保护，此时不能删除该伸缩组。
• false：关闭伸缩组删除保护。

默认值：false。

伸缩组管理的实例类型。取值范围：

• ECS：伸缩组内管理的伸缩实例为ECS实例。
• ECI：伸缩组内管理的伸缩实例为ECI实例。

默认值：ECS。

ECI实例ID，即容器组ID。

一台或多台虚拟交换机的ID。如果您使用了VSwitchIds.N参数，VSwitchId参数将被忽略。指定后，伸缩组的网络类型为专有网络。

指定多台虚拟交换机时：

• 所属的VPC必须相同。
• 所属的可用区可以不同。
• 虚拟交换机的优先级按照数字升序排序，1表示最高优先级。当优先级较高的虚拟交换机所在可用区无法创建ECS实例时，自动选择下一优先级的虚拟交换机创建ECS实例。

等待状态结束后的下一步动作。取值范围：

• CONTINUE：继续响应弹性扩张活动或者继续响应弹性收缩活动。
• ABANDON：直接释放弹性扩张活动创建出来的ECS实例或者直接将弹性收缩活动中的ECS实例从伸缩组移除。

当伸缩组发生弹性收缩活动（SCALE_IN）并触发多个生命周期挂钩时，DefaultResult取值为ABANDON的生命周期挂钩触发的等待状态结束时，会提前结束其它对应的等待状态。其他情况下，下一步动作均以最后一个结束等待状态的下一步动作为准。

默认值：CONTINUE。

生命周期挂钩名称，指定后不支持修改，未指定时默认与生命周期挂钩ID相同。

生命周期挂钩适用的伸缩活动类型，取值范围：

• SCALE_OUT：伸缩组弹性扩张活动。
• SCALE_IN：伸缩组弹性收缩活动。

伸缩活动的等待状态的固定字符串信息。参数长度不能超过128个字符。弹性伸缩每次推送消息到通知对象时，会同时发送您预先指定的NotificationMetadata参数值，便于管理和标记不同类别的通知信息。当您同时指定了NotificationArn参数时，NotificationMetadata参数方可生效。

生命周期挂钩通知对象标识符，支持轻量消息队列（原 MNS）的队列或主题，参数取值格式：acs:ess:{region}:{account-id}:{resource-relative-id}。

• region：伸缩组所在的地域。
• account-id：阿里云账号ID。

例如：

• MNS队列：acs:ess:{region}:{account-id}:queue/{queuename}。
• MNS主题：acs:ess:{region}:{account-id}:topic/{topicname}。

生命周期挂钩为伸缩组活动设置的等待时间，等待状态超时后会执行下一步动作。取值范围：30~21600，单位：秒。

创建了生命周期挂钩后，您可以调用RecordLifecycleActionHeartbeat延长ECS实例的等待时间，也可以调用CompleteLifecycleAction提前结束伸缩活动的等待状态。

默认值：600。

虚拟服务器组ID。

更多信息，请参见AttachVServerGroups。

弹性伸缩将实例添加到虚拟服务器组后，实例作为后端服务器的权重。权重越高，实例将被分配到越多的访问请求。如果权重为0，则实例不会收到访问请求。取值范围：0~100。默认值：50。

更多信息，请参见AttachVServerGroups。

弹性伸缩将实例添加到虚拟服务器组后，实例使用的端口号，取值范围：1~65535。

更多信息，请参见AttachVServerGroups。

虚拟服务器组所属传统型负载均衡CLB（原SLB）实例的ID。

更多信息，请参见AttachVServerGroups。

伸缩组的标签键。

伸缩组的标签值。

标识该标签是否为可传播标签，取值范围：

• true：伸缩组上的标签只会传播到新创建的实例上，而不会传播到已经在伸缩组中运行的实例上。
• false：伸缩组上的标签不会传播到实例上。

默认值：false。

当您需要伸缩组按照实例规格容量进行伸缩时，请同时指定本参数和LaunchTemplateOverride.N.WeightedCapacity。

本参数用于指定实例规格，会覆盖启动模板中的实例规格。您可以指定N个本参数，扩展启动模板支持N个实例规格。N的取值范围：1~10。

InstanceType的取值范围：在售的ECS实例规格，请参见实例规格族。

当您需要伸缩组按照实例规格容量进行伸缩时，在指定LaunchTemplateOverride.N.InstanceType后，再指定本参数。两个参数一一对应，N需要保持一致。

本参数用于指定实例规格的权重，即实例规格的单台实例在伸缩组中表示的容量大小。权重越大，满足期望容量所需的本实例规格的实例数量越少。

由于每个实例规格的vCPU个数、内存大小等性能指标会有差异，您可以根据自身需求，给不同的实例规格配置不同的权重。

例如：

• 当前容量：0。
• 期望容量：6。
• ecs.c5.xlarge规格容量：4。

为满足期望容量，伸缩组将为用户扩容2台ecs.c5.xlarge实例。

WeightedCapacity的取值范围：1~500。

本参数用于指定实例启动模板覆盖规格（即LaunchTemplateOverride.N.InstanceType）的竞价价格上限。您可以指定N个该参数，扩展启动模板支持N个实例规格。N的取值范围：1~10。

ALB服务器组ID。

N为ALB服务器组的编号。一个伸缩组支持关联的ALB服务器组数量有限，如需查看或手动申请提升配额值，请前往配额中心。

弹性伸缩将实例添加到ALB服务器组后，实例作为后端服务器的权重。权重越高，实例将被分配到越多的访问请求。如果权重为0，则实例不会收到访问请求。取值范围：0~100。

N为ALB服务器组的编号。

弹性伸缩将实例添加到ALB服务器组后，实例使用的端口号，取值范围：1~65535。

N为ALB服务器组的编号。

服务器组的ID。

服务器组类型。取值范围：

• ALB：表示应用型负载均衡（Application Load Balancer）。
• NLB：表示网络型负载均衡（Network Load Balancer）。

弹性伸缩将实例添加到服务器组后，实例作为后端服务器的权重。取值范围：0~100。

权重越高，实例将被分配到越多的访问请求。如果权重为0，则实例不会收到访问请求。

弹性伸缩将实例添加到服务器组后，实例使用的端口号。取值范围：1~65535。

伸缩组的容量是否在多个可用区间均衡分布（仅当MultiAZPolicy参数取值为COMPOSABLE策略时生效），取值范围：

• true：伸缩组的容量在多个可用区间均衡分布。
• false：伸缩组的容量不在多个可用区间均衡分布。

默认值：false。

容量分配策略，决定了伸缩组如何选择可用的实例规格类型满足容量。容量分布策略同时对按量和抢占式容量生效（仅当MultiAZPolicy参数取值为COMPOSABLE策略时生效）。取值范围：

• priority：按照配置的实例规格的顺序创建实例。
• lowestPrice：按照实例规格单位vCpu价格从低到高创建实例。

默认值：priority。

抢占式容量分布策略。您可以通过该参数单独指定抢占式容量的分布策略（仅当MultiAZPolicy参数取值为COMPOSABLE策略时生效）。取值范围：

• priority：按照配置的实例规格的顺序创建实例。
• lowestPrice：按照实例规格单位vCpu价格从低到高创建实例。

默认值：priority。

实例在伸缩组中存活的最大时间。单位为秒。

取值范围：[86400, Integer.maxValue]。

默认值：null。

自定义缩容策略Function函数ARN。仅当RemovalPolicies配置第一个移除策略为CustomPolicy时生效。

新创建的伸缩组所属的资源组ID。

负载均衡CLB（原SLB）实例的ID。

弹性伸缩将实例添加到负载均衡CLB（原SLB）服务器组后，实例作为后端服务器的权重。权重越高，实例将被分配到越多的访问请求。如果权重为0，则实例不会收到访问请求。

取值范围：0~100。

伸缩组的健康检查方式列表。取值范围：

• NONE：不做健康检查。
• ECS：对伸缩组内的实例做健康检查（ECS类型和ECI类型的伸缩组均使用本取值开启实例健康检查）。
• LOAD_BALANCER: 根据负载均衡（暂不支持负载均衡CLB类型）健康检查结果判断实例健康状态。

默认值：ECS。

数据库实例ID。

数据库类型。取值范围：

• RDS。
• Redis。
• MongoDB。

默认值：RDS。

伸缩组与数据库关联方式。取值范围：

• SecurityIp ：修改IP白名单模式，通过将扩容实例自动添加到数据库IP白名单（目前仅RDS数据库支持）。
• SecurityGroup：安全组模式，通过将伸缩配置安全组添加至数据库安全组白名单，实现安全组下实例数据库访问。

缩容流程中等待ECS实例停机成功的超时时间，单位为秒。

取值范围：30~240。

请求ID。

伸缩组ID。