RemoveInstances - 弹性伸缩

接口说明

调用本接口前请确保满足以下条件：
- 伸缩组处于启用（Active）状态。
- 伸缩组中没有正在执行的伸缩活动。

当伸缩组没有执行中的伸缩活动时，该接口可以绕过冷却时间（DefaultCooldown）直接执行。

如果一台ECS实例由弹性伸缩自动创建，或者您手动添加但已托管给伸缩组，从伸缩组删除该ECS实例时，ECS实例触发了节省停机效果或者被释放。
如果一台ECS实例由您手动添加且未托管给伸缩组，从伸缩组删除该ECS实例时，ECS实例不会被停止或者释放。
如果当前伸缩组的实例数（TotalCapacity）减去该接口指定的实例数小于伸缩组内最小实例数（MinSize），则调用失败。

调用该接口返回成功，只是表示弹性伸缩服务接受了该接口调用的请求，伸缩活动可以执行，但不代表伸缩活动能够执行成功。您需要通过返回的ScalingActivityId查看该伸缩活动的执行状态。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	RemoveInstances	系统规定参数。取值：RemoveInstances。
ScalingGroupId	String	是	asg-bp18p2yfxow2dloq****	伸缩组的ID。
RemovePolicy	String	否	release	指定被删除ECS实例的动作。取值范围： recycle：ECS实例触发了节省停机效果。说明仅在`ScalingPolicy`为`recycle`时生效。 release：ECS实例被释放。 CreateScalingGroup的`ScalingPolicy`参数指定伸缩组的回收模式，但实例被删除时的具体动作，由RemoveInstances的`RemovePolicy`参数决定。例如： `ScalingPolicy`为`recycle`，且`RemovePolicy`为`recycle`，ECS实例触发了节省停机效果。 `ScalingPolicy`为`recycle`，且`RemovePolicy`为`release`，ECS实例被释放。 `ScalingPolicy`为`release`，且`RemovePolicy`为`recycle`，ECS实例被释放。 `ScalingPolicy`为`release`，且`RemovePolicy`为`release`，ECS实例被释放。默认值：release。
DecreaseDesiredCapacity	Boolean	否	true	是否修改期望实例数。取值范围： true：从伸缩组删除ECS实例后，期望实例数也减少相应台数。 false：从伸缩组删除ECS实例后，期望实例数不会变化。默认值：true。
IgnoreInvalidInstance	Boolean	否	false	从伸缩组删除一批实例时，是否忽略其中无效的实例。取值范围： true：从伸缩组中删除一批实例时会忽略无效实例。如果一批实例中存在无效实例（例如实例状态为`加入中`），并且有效的实例被成功删除时，伸缩活动执行状态显示为`警告`状态，您可以从伸缩活动详情查看无效的实例。 false：从伸缩组中删除一批实例时不会忽略无效实例。如果一批实例中存在无效的实例，则返回结果会报错。默认值：false。
InstanceId.N	String	否	i-28wt4****	待删除ECS实例的ID。N的取值范围：1~20。
RegionId	String	否	cn-qingdao	伸缩组所属的地域ID。
ClientToken	String	否	123e4567-e89b-12d3-a456-42665544****	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持ASCII字符，且不能超过64个字符。更多信息，请参见如何保证幂等性。
StopInstanceTimeout	Integer	否	60	缩容流程中等待ECS实例停机成功的超时时间，单位为秒。取值范围：30~240。说明该参数值默认从伸缩组继承，您也可以在调用RemoveInstances时重新设置。该参数仅在 RemovePolicy = release 模式下的缩容流程里生效。如果设置了该参数，系统会最长等待StopInstanceTimeout时间将实例停机成功，超时后无论实例是否成功停机都会继续缩容。如果没有设置该参数，系统会长时间等待实例停机成功，只有实例停机成功后才继续缩容，停机失败时，缩容流程会回滚，缩容失败。

返回数据

名称	类型	示例值	描述
ScalingActivityId	String	asa-bp175o6f6ego3r2j****	伸缩活动的ID。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****	请求ID。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=RemoveInstances
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&RemovePolicy=release
&DecreaseDesiredCapacity=true
&IgnoreInvalidInstance=false
&InstanceId=["i-28wt4****"]
&RegionId=cn-qingdao
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&公共请求参数

正常返回示例

XML格式

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

<RemoveInstancesResponse>
    <ScalingActivityId>asa-bp175o6f6ego3r2j****</ScalingActivityId>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
</RemoveInstancesResponse>

JSON格式

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

{
  "ScalingActivityId" : "asa-bp175o6f6ego3r2j****",
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

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

HttpCode	错误码	错误信息	描述
404	InvalidScalingGroupId.NotFound	The specified scaling group does not exist.	指定的伸缩组在该用户账号下不存在。
404	InvalidInstanceId.NotFound	Instance "XXX" does not exist.	指定的ECS实例在伸缩组下不存在。
400	InvalidParameter	The specified group does not support the specified RemovePolicy.	当前伸缩组不支持停机回收策略。
403	Forbidden.Unauthorized	A required authorization for the specified action is not supplied.	您未向弹性伸缩授予完整的OpenAPI接口权限。
400	IncorrectScalingGroupStatus	The current status of the specified scaling group does not support this action.	指定的伸缩组未处于Active状态。
400	ScalingActivityInProgress	You cannot delete a scaling group or launch a new scaling activity while there is a scaling activity in progress for the specified scaling group.	指定的伸缩组有进行中的伸缩活动。
400	IncorrectLoadBalancerStatus	The current status of the specified load balancer does not support this action.	指定伸缩规则所属的伸缩组的负载均衡实例未处于Active状态。
400	IncorrectDBInstanceStatus	The current status of DB instance "XXX" does not support this action.	指定伸缩规则所属的伸缩组的RDS实例未处于Running状态。
400	IncorrectCapacity.MinSize	To remove the instances, the total capacity will be lesser than the MinSize.	删除ECS实例使得TotalCapacity小于MinSize。