调用ModifyScalingGroup修改一个伸缩组。

接口说明

  • 不支持修改以下参数:
  • 当伸缩组的状态为Active或Inactive时才能调用该接口。
  • 启用新的伸缩配置不会影响通过早前伸缩配置创建并正在运行的ECS实例。
  • 如果修改了MaxSize,导致伸缩组的ECS实例数超过MaxSize,伸缩组会自动移出ECS实例,使得伸缩组的ECS实例数等于MaxSize。
  • 如果修改了MinSize,导致伸缩组的ECS实例数低于MinSize,伸缩组会自动加入ECS实例,使得伸缩组的ECS实例数等于MinSize。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyScalingGroup

系统规定参数。取值:ModifyScalingGroup

ScalingGroupId String asg-bp1ffogfdauy0jw0****

待修改伸缩组的ID。

ScalingGroupName String scalinggroup****

伸缩组的名称,同一地域下伸缩组名称唯一。长度为2~64个英文或中文字符,以数字、大小英文字母或中文开头,可以包含数字、下划线(_)、连字符(-)和小数点(.)。

MinSize Integer 1

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

说明 MinSize的值必须小于或等于MaxSize。
MaxSize Integer 99

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

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

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

VSwitchIds.N RepeatList vsw-bp1oo2a7isyrb8igf****

一台或多台虚拟交换机的ID,N的取值范围:1~5。

只有当伸缩组网络类型为VPC时,当前参数才生效。指定虚拟交换机所属的VPC必须和伸缩组所属的VPC相同。

虚拟交换机可以来自多个可用区。虚拟交换机的优先级按照数字升序排序,1表示最高优先级。当优先级较高的虚拟交换机所在可用区无法创建ECS实例时,自动选择下一优先级的虚拟交换机创建ECS实例。

DefaultCooldown Integer 600

一次伸缩活动(添加或移出ECS实例)结束后的一段冷却时间。取值范围:0~86400,单位:秒。

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

RemovalPolicy.1 String OldestScalingConfiguration

RemovalPolicy.N指定移出ECS实例的伸缩组策略,N的取值范围:1~2。取值范围:

  • OldestInstance:移出最早加入伸缩组的ECS实例
  • NewestInstance:移出最新加入伸缩组的ECS实例
  • OldestScalingConfiguration:移出最早伸缩配置创建的ECS实例
ActiveScalingConfigurationId String asc-bp17pelvl720x5ub****

伸缩组内生效的伸缩配置的ID。

HealthCheckType String ECS

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

  • NONE:不做健康检查。
  • ECS:对伸缩组内的ECS实例做健康检查。
LaunchTemplateId String lt-m5e3ofjr1zn1aw7****

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

LaunchTemplateVersion String Default

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

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

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

OnDemandPercentageAboveBaseCapacity Integer 20

伸缩组满足最小按量实例数(OnDemandBaseCapacity)要求后,超出的实例中按量实例应占的比例,取值范围:0~100。

SpotInstanceRemedy Boolean true

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

CompensateWithOnDemand Boolean true

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

  • true:允许。
  • false:不允许。
SpotInstancePools Integer 5

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

DesiredCapacity Integer 5

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

GroupDeletionProtection Boolean true

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

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

返回数据

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

示例

请求示例

https://ess.aliyuncs.com/?Action=ModifyScalingGroup
&ScalingGroupId=asg-bp1ffogfdauy0jw0****
&ScalingGroupName=Scaling****
&<公共请求参数>

正常返回示例

XML 格式

<ModifyScalingGroupResponse>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</ModifyScalingGroupResponse>

JSON 格式

{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

访问错误中心查看更多错误码。

HttpCode

错误码

错误信息

描述

404

InvalidScalingGroupId.NotFound

The specified scaling group does not exist.

账号下不存在指定的伸缩组。

400

InvalidScalingGroupName.Duplicate

The specified value of parameter &lt;parameter name&gt; is duplicated.

伸缩组名已存在。

404

InvalidScalingConfigurationId.NotFound

The specified scaling configuration does not exist.

伸缩组中不存在指定的伸缩配置。

400

InvalidScalingConfigurationId.InstanceTypeMismatch

The specified scaling configuration and existing active scaling configuration have different instance type.

指定的伸缩配置的实例规格与当前生效的伸缩配置的实例规格不匹配。

400

InvalidParameter.Conflict

The value of parameter &lt;parameter name&gt; and parameter &lt;parameter name&gt; are confilict.

指定的MinSize大于MaxSize。

400

LaunchTemplateVersionSet.NotFound

The specific version of launch template is not exist.

不存在指定的实例启动模板版本。

400

LaunchTemplateSet.NotFound

The specified launch template set is not found.

不存在指定的实例启动模板。

400

TemplateMissingParameter.ImageId

The input parameter "ImageId" that is mandatory for processing this request is not supplied.

实例启动模板指定版本缺少镜像信息。

400

TemplateMissingParameter.InstanceTypes

The input parameter "InstanceTypes" that is mandatory for processing this request is not supplied.

指定的实例启动模板版本缺少实例规格信息。

400

TemplateMissingParameter.SecurityGroup

The input parameter "SecurityGroup" that is mandatory for processing this request is not supplied.

指定的实例启动模板版本缺少安全组信息。

400

TemplateVersion.NotNumber

The input parameter "LaunchTemplateVersion" is supposed to be a string representing the version number.

指定的实例启动模板固定版本号应该是数字。