You need to enable JavaScript to run this app.
导航
弹性伸缩
  • 文档首页
    • /
  • 弹性伸缩

ModifyScalingGroup

最近更新时间：2024.03.14 19:20:16

首次发布时间：2022.05.13 10:42:44

我的收藏

调用 ModifyScalingGroup 修改一个伸缩组的基本信息和所属子网，可选参数如果不填则表示不修改该参数，操作说明请参见修改伸缩组的实例数量信息。

请求参数

名称类型是否必填示例值
描述
ActionString是ModifyScalingGroup要执行的操作，取值：ModifyScalingGroup。
VersionString是2020-01-01API的版本，取值为：2020-01-01。
ScalingGroupIdString是scg-yblhryq64wgh9zmp****伸缩组ID。您可以调用DescribeScalingGroups 接口查询伸缩组ID。

ScalingGroupName

String

否

scaling-group-test

伸缩组名称，同一地域下伸缩组名称唯一，取值:

  • 只能以中文、字母开头。
  • 只能包含中文、字母、数字、下划线和中划线。
  • 长度限制为1 ~ 128个字符 。
  • 暂不支持特殊字符。
LaunchTemplateIdString否lt-yc5kwj1di33uw1qj****实例启动模板ID，配置后表示选择启动模版作为伸缩配置来源。

LaunchTemplateVersion

String

否

Default

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

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

说明

本参数仅当LaunchTemplateId参数存在取值时生有效。

LaunchTemplateOverrides.N.InstanceType

String

否

LaunchTemplateOverrides.1.InstanceType=ecs.g2i.large

指定实例规格。

  • 参数 - N：表示实例规格的序号，取值为1 ～ 10。
  • 取值 - InstanceType：表示实例规格。
  • 多个实例规格之间用&分隔。

说明

本参数仅当LaunchTemplateId参数存在取值时生有效。

LaunchTemplateOverrides.N.PriceLimit

Float32

否

LaunchTemplateOverrides.1.PriceLimit=0.001

指定抢占式实例规格每小时的最高价格。

  • 参数 - N：表示实例规格的序号，取值为1 ～ 10。
  • 取值 - PriceLimit：表示抢占式实例规格每小时的最高价格。取值：大于0，且最大不超过3位小数。
  • 多个价格之间用&分隔。

说明

本参数仅当LaunchTemplateId参数存在取值，且启动模版的计费模式为设置出价上限的抢占式实例（即SpotWithPriceLimit）时有效。

DefaultCooldown

Integer

否

300

执行一次伸缩活动（添加或移出ECS实例）结束后的冷却时间。
冷却时间内，该伸缩组不执行其它的伸缩活动，仅针对云监控报警任务触发的伸缩活动和伸缩规则有效。
取值范围：5 ~ 86400，单位：秒。

DesireInstanceNumber

Integer

否

2

伸缩组中期望运行的实例个数，仅创建伸缩组时设置了期望实例数才能修改该值。更多介绍请参见 期望实例数。

  • 修改期望实例数后，将立即触发一次健康检查行为，组中的实例个数也将会随之变化。
  • 取值：不小于最小实例数MinInstanceNumber且不大于最大实例数MaxInstanceNumber。
MinInstanceNumberInteger否1伸缩组中实例个数的最小值，默认值为1。取值范围0 ～ 100。
MaxInstanceNumberInteger否3伸缩组中实例个数的最大值，默认值为1。取值范围0 ～ 100。
ActiveScalingConfigurationIdString否scc-yblhz5oxzml8j1gv****伸缩组绑定的伸缩配置的ID。您可以调用DescribeScalingConfigurations 接口查询伸缩配置ID。

SubnetIds.N

String

否

SubnetIds.1=subnet-24sdlkdplsjkdjd****

伸缩组中实例主网卡的子网ID，修改后与修改前的子网ID必须属于同一私有网络。您可以调用DescribeSubnets接口查询子网ID和子网所属的VPC信息。

  • 参数 - N：表示子网的序号，支持多选。多个子网需属于同一个VPC，同一可用区只允许选择一个子网。
  • 取值 - SubnetId：表示子网ID。

InstanceTerminatePolicy

String

否

NewestInstance

实例移除策略，取值：

  • OldestInstance：移出最早加入（包括自动创建和手动添加）伸缩组的实例。
  • NewestInstance：移出最晚加入（包括自动创建和手动添加）伸缩组的实例。
  • OldestScalingConfigurationWithOldestInstance：移出最早与伸缩组绑定的伸缩配置中，最早由伸缩组 自动创建 的实例。
  • OldestScalingConfigurationWithNewestInstance：移出 最早与伸缩组绑定的伸缩配置中，最晚由伸缩组 自动创建 的实例。

MultiAZPolicy

String

否

PRIORITY

多子网伸缩组的扩缩容策略。取值：

  • PRIORITY：优先级策略。
  • BALANCE：均衡分布策略。
    选择策略后的实例扩缩容情况请参见创建伸缩组中的“扩缩容”参数说明。

InstancesDistribution.OnDemandBaseCapacity

Integer

否

2000

伸缩组中按量计费实例个数的最小值，取值范围：0~2000。当组中按量计费实例个数少于该值时，将优先创建按量计费的实例。

说明

该参数仅当伸缩组绑定的伸缩配置来源的计费类型为抢占式类型时生效，且该参数不影响最终创建的实例数量，实例数量仍有最大/最小/期望实例数限制。

InstancesDistribution.OnDemandPercentageAboveBaseCapacity

Integer

否

0

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

说明

该参数仅当伸缩组绑定的伸缩配置来源的计费类型为抢占式类型时生效。

InstancesDistribution.CompensateWithOnDemand

Boolean

否

false

如果因价格、库存等原因无法创建足够的抢占式实例，是否允许使用按量实例补充抢占式容量。取值：

  • true: 允许。
  • false: 不允许。

InstancesDistribution.SpotInstanceRemedy

Boolean

否

false

是否允许抢占式实例到期替换。开启则表示在抢占式实例被回收前5分钟左右，伸缩组将主动新建新的抢占式实例替换掉当前抢占式实例。取值：

  • true: 允许。
  • false: 不允许。

HealthCheckType

String

否

ECS

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

  • ECS（默认）：对伸缩组内的ECS实例做健康检查。
  • NONE：不做实例健康状态检查。

返回数据

名称类型示例值说明
ScalingGroupIdStringscg-yblhryq64wgh9zmp****伸缩组ID。

请求示例

GET /?Action=ModifyScalingGroup&ScalingGroupId=scg-yblhryq64wgh9zmp****ActiveScalingConfigurationId=scc-yblhz5oxzml8j1gv****&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: auto_scaling

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202204191650450102252430810402****",
        "Action": "ModifyScalingGroup",
        "Version": "2020-01-01",
        "Service": "auto_scaling",
        "Region": "cn-beijing"
    },
    "Result": {
        "ScalingGroupId": "scg-yblhryq64wgh9zmp****"
    }
}