StartInstanceRefresh_弹性伸缩(ESS)-阿里云帮助中心

接口说明

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

调试

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

请求参数

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

返回数据

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

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=StartInstanceRefresh
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&MinHealthyPercentage=80
&MaxHealthyPercentage=100
&DesiredConfiguration={"ImageId":"m-2ze8cqacj7opnf***","ScalingConfigurationId":"asc-2zed7lqn4ts4****"}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<StartInstanceRefreshResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <InstanceRefreshTaskId>ir-a12ds234fasd*****</InstanceRefreshTaskId>
</StartInstanceRefreshResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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