ModifyScalingGroup_弹性伸缩_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 不支持修改以下参数:

    • RegionId

    • LoadBalancerId

    说明 如果需要修改负载均衡实例,请使用 AttachLoadBalancers 和 DetachLoadBalancers 接口。
    • DBInstanceId

    说明 如果需要修改 RDS 实例,请使用 AttachDBInstances 和 DetachDBInstances 接口。
  • 当伸缩组的状态为ActiveInactive时才能调用该接口。

  • 启用新的伸缩配置不会影响通过早前伸缩配置创建并正在运行的 ECS 实例或 ECI 实例。

  • 如果修改了 MaxSize,导致当前伸缩组的 ECS 或 ECI 实例数超过 MaxSize,则伸缩组会自动移出 ECS 实例或 ECI 实例,使得伸缩组的 ECS 或 ECI 实例数等于 MaxSize。

  • 如果伸缩组修改了 MinSize,导致当前伸缩组的 ECS 或 ECI 实例数低于 MinSize,则伸缩组会自动加入 ECS 实例或 ECI 实例,使得伸缩组的 ECS 或 ECI 实例数等于 MinSize。

  • 如果伸缩组设置了 DesiredCapacity 时,修改了 DesiredCapacity,导致当前伸缩组的 ECS 或 ECI 实例数与 DesiredCapacity 不一致,则伸缩组会自动加入或移除 ECS 实例或 ECI 实例,使得伸缩组的 ECS 或 ECI 实例数等于 DesiredCapacity。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ess:ModifyScalingGroup
Update
ScalingGroup
acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

请求参数

字段名称字段详情
ScalingGroupIdstring

待修改伸缩组的 ID。

示例值:asg-bp1ffogfdauy0jw0****参考取值来源:
    ApplyScalingGroup
    CreateScalingGroup
    DescribeScalingGroups
    DetachServerGroups
    AttachServerGroups
ScalingGroupNamestring

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

示例值:scalinggroup****参考取值来源:
    DescribeScalingGroups
MinSizeinteger<int32>

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

示例值:1
MaxSizeinteger<int32>

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

示例值:99
DefaultCooldowninteger<int32>

伸缩组默认的冷却时间,仅适用于简单规则。取值范围:0~86400,单位:秒。展开详情

示例值:600取值 <= 86400
RemovalPoliciesarray<string>

指定移出 ECS 实例的伸缩组策略。取值范围:展开详情

子级条数 <= 2
ActiveScalingConfigurationIdstring

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

示例值:asc-bp17pelvl720x5ub****参考取值来源:
    DescribeScalingGroupDetail
HealthCheckTypestring

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

示例值:ECS
LaunchTemplateIdstring

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

示例值: lt-m5e3ofjr1zn1aw7****
LaunchTemplateVersionstring

实例启动模板的版本。取值范围:展开详情

示例值:Default
OnDemandBaseCapacityinteger<int32>

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

示例值:30
OnDemandPercentageAboveBaseCapacityinteger<int32>

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

示例值:20
SpotInstanceRemedyboolean

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

示例值:true
CompensateWithOnDemandboolean

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

示例值:true
SpotInstancePoolsinteger<int32>

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

示例值:5
DesiredCapacityinteger<int32>

伸缩组内 ECS 实例或 ECI 实例的期望数量,伸缩组会自动将 ECS 实例或 ECI 实例数量维持在期望实例数。取值范围:MaxSize≥期望实例数量≥MinSize。展开详情

示例值:5
GroupDeletionProtectionboolean

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

示例值:true
MultiAZPolicystring

多可用区伸缩组 ECS 实例扩缩容策略。取值范围:展开详情

示例值:PRIORITY参考取值来源:
    DescribeScalingGroupDetail
VSwitchIdsarray<string>

一台或多台虚拟交换机的 ID。展开详情

子级条数 <= 8
LaunchTemplateOverridesarray<object>

扩展启动模板的实例规格信息。

子级条数 <= 10
MaxInstanceLifetimeinteger<int32>

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

示例值:null
AzBalanceboolean

伸缩组的容量是否在多个可用区间均衡分布(仅当MultiAZPolicy参数取值为COMPOSABLE策略时生效),取值范围:展开详情

示例值:false
AllocationStrategystring

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

示例值:priority
SpotAllocationStrategystring

抢占式容量分布策略。您可以通过该参数单独指定抢占式容量的分布策略(仅当MultiAZPolicy参数取值为COMPOSABLE策略时生效)。取值范围:展开详情

示例值:lowestPrice
CustomPolicyARNstring

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

示例值:acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name
DisableDesiredCapacityboolean

伸缩组是否关闭期望实例数功能。取值范围:展开详情

示例值:false
ScalingPolicystring

指定伸缩组的回收模式。取值范围: 展开详情

示例值:recycle参考取值来源:
    DescribeScalingGroups
HealthCheckTypesarray<string>

伸缩组的健康检查方式。展开详情

子级条数 <= 100
StopInstanceTimeoutinteger<int32>

缩容流程中等待 ECS 实例停机成功的超时时间,单位为秒。展开详情

示例值:60
CapacityOptionsobject

容量选项。

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

返回示例

变更历史

变更时间变更内容概要操作
2025-02-18
变更请求参数CapacityOptions
2024-12-03
新增请求参数CapacityOptions
2024-10-16
新增请求参数StopInstanceTimeout
2024-02-22
新增请求参数ScalingPolicy
2024-02-01
新增请求参数HealthCheckTypes
2023-10-18
新增请求参数DisableDesiredCapacity
2022-12-22
变更请求参数LaunchTemplateOverrides
  • 1
  • 2
  • 10 条/页

相关示例