调用StartInstanceRefresh启动伸缩组实例刷新任务-弹性伸缩-阿里云-弹性伸缩(ESS)-阿里云帮助中心

在您需要将新的伸缩配置应用到伸缩组实例中时，或需要更新伸缩组中实例的镜像时，您可以调用本接口完成伸缩组中实例的刷新。

接口说明

伸缩组同时刻只能有一个正在运行中的实例刷新任务。
目前该功能仅支持扩容策略为优先级策略的 ECS 伸缩组。使用 vCPU 个数计算伸缩组容量的伸缩组和实例回收模式为停机回收模式、强制停机回收模式的伸缩组不支持该功能。
实例刷新期间，可以进行正常扩缩容，但扩容时会以实例刷新的期望配置进行扩容。
伸缩组手动添加的实例、处于备用状态、保护状态的实例会被实例刷新任务忽略，不参与实例刷新。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ess:StartInstanceRefresh

update

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

无

请求参数

名称	类型	必填	描述	示例值
ScalingGroupId	string	是	伸缩组 ID。	asg-bp18p2yfxow2dloq****
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。	123e4567-e89b-12d3-a456-42665544****
RegionId	string	是	伸缩组所属的地域 ID。	cn-hangzhou
MinHealthyPercentage	integer	否	实例刷新期间，保持伸缩组中正常提供服务占伸缩组容量的比例。取值范围 0～100。默认值：80。	80
MaxHealthyPercentage	integer	否	实例刷新期间，伸缩组中实例可以超出伸缩组容量的比例。取值范围 100～200。默认值：120。说明当 MinHealthyPercentage = MaxHealthyPercentage = 100 时，每次会刷新 1 个实例。	100
DesiredConfiguration	object	否	实例刷新的期望配置。说明 ScalingConfigurationId 、ImageId、LaunchTemplateId、Containers 不可以同时设置。当该参数为空时，以伸缩组当前生效的配置进行刷新。实例刷新任务执行成功后，伸缩组生效的伸缩配置会更新为该配置。
ImageId	string	否	镜像 ID。说明实例刷新任务执行成功后，伸缩组当前生效的配置信息中的镜像配置会更新为该镜像。伸缩组当前生效的配置信息来源是启动模版时不支持设置该参数。	m-2ze8cqacj7opnf***
ScalingConfigurationId	string	否	伸缩配置的 ID。	asc-2zed7lqn4ts4****
LaunchTemplateId	string	否	实例启动模板的 ID，用于指定伸缩组从实例启动模板获取启动配置信息。	lt-2ze2qli30u***
LaunchTemplateVersion	string	否	实例启动模板的版本。取值范围：固定的模板版本号。 Default：始终使用模板默认版本。 Latest：始终使用模板最新版本。说明版本设置为 Default、Latest 时，实例刷新任务不支持回滚。	8
LaunchTemplateOverrides	array<object>	否	扩展启动模板的实例规格信息。
	object	否	扩展启动模板的实例规格信息。
InstanceType	string	否	本参数用于指定实例规格，会覆盖启动模板中的实例规格。说明仅当 LaunchTemplateId 参数指定了启动模板时，本参数生效。	ecs.c5.2xlarge
Containers	array<object>	否	实例包含的容器列表。说明该参数仅支持 ECI 类型伸缩组。只会刷新当前伸缩配置容器列表中和`Container.Name`相同的容器配置。
	array<object>	否	实例包含的容器列表。
Name	string	否	自定义的容器名称。	nginx
Image	string	否	容器镜像。	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
Commands	array	否	容器启动命令。最多 20 个。每个命令最多包含 256 个字符。
	string	否	容器启动命令。最多 20 个。每个命令最多包含 256 个字符。	sleep
Args	array	否	容器启动命令对应的参数。最多 10 个。
	string	否	容器启动命令对应的参数。最多 10 个。	100
EnvironmentVars	array<object>	否	环境变量的信息。
	object	否	环境变量的信息。
Key	string	否	环境变量名。长度为 1~128 位。格式要求：[0-9a-zA-Z]，以及下划线，不能以数字开头。	PATH
Value	string	否	环境变量值。长度为 0~256 位。	/usr/local/bin
FieldRefFieldPath	string	否	说明该参数未开放使用。	fieldPath
SkipMatching	boolean	否	是否跳过和期望配置匹配的实例。说明系统会根据期望伸缩配置的 ID 界定是否匹配，不会对比具体的配置项。取值范围： true：跳过。当启动实例刷新任务时，系统会检查每个实例的配置。对于已经使用期望配置创建的实例，不执行刷新操作。 false：不跳过。在启动实例刷新任务后，刷新任务启动时所有伸缩组中的实例。默认值：true。	true
Checkpoints	array<object>	否	刷新任务检查点：指定在实例刷新过程中，当新实例占比达到设定值时自动暂停任务 CheckpointPauseTime 分钟。
	object	否	刷新任务检查点：指定在实例刷新过程中，当新实例占比达到设定值时自动暂停任务`CheckpointPauseTime`分钟。
Percentage	integer	否	伸缩组中新实例占总实例的占比，到达该占比时任务自动暂停。取值范围：1 ～100 （%）。说明需要从小到大设置，且最后一个进度百分比需要为 100。	20
CheckpointPauseTime	integer	否	当进入刷新任务检查点时，暂停的时长。单位：分钟取值范围 : 1～ 2880 默认值：60。	10
Strategy	string	否

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
InstanceRefreshTaskId	string	实例刷新任务 ID。	ir-a12ds234fasd*****

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InstanceRefreshTaskId": "ir-a12ds234fasd*****"
}

错误码

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

变更历史

更多信息，参考变更详情。