RemoveInstances_弹性伸缩_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.

接口说明

  • 调用本接口前请确保满足以下条件:
    • 伸缩组处于启用(Active)状态。
    • 伸缩组中没有正在执行的伸缩活动。
说明 当伸缩组没有执行中的伸缩活动时,该接口可以绕过冷却时间(DefaultCooldown)直接执行。
  • 如果一台 ECS 实例由弹性伸缩自动创建,或者您手动添加但已托管给伸缩组,从伸缩组删除该 ECS 实例时,ECS 实例触发了节省停机效果或者被释放。
  • 如果一台 ECS 实例由您手动添加且未托管给伸缩组,从伸缩组删除该 ECS 实例时,ECS 实例不会被停止或者释放。
  • 如果当前伸缩组的实例数(TotalCapacity)减去该接口指定的实例数小于伸缩组内最小实例数(MinSize),则调用失败。

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

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
ScalingGroupIdstring

伸缩组的 ID。

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

指定被删除 ECS 实例的动作。取值范围:展开详情

示例值:release
DecreaseDesiredCapacityboolean

是否修改期望实例数。取值范围:展开详情

示例值:true
IgnoreInvalidInstanceboolean

从伸缩组删除一批实例时,是否忽略其中无效的实例。取值范围:展开详情

示例值:false
InstanceIdsarray<string>

待删除 ECS 实例的 ID。

子级条数 <= 1000
RegionIdstring

伸缩组所属的地域 ID。

示例值:cn-qingdao参考取值来源:
    DescribeRegions
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

示例值:123e4567-e89b-12d3-a456-42665544****
StopInstanceTimeoutinteger<int32>

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

示例值:60
LifecycleHookContextobject

生命周期挂钩上下文信息。

返回参数

字段名称字段详情
ScalingActivityIdstring

伸缩活动的 ID。

示例值:asa-bp175o6f6ego3r2j****
RequestIdstring

请求 ID。

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

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
500
InternalError
The request processing has failed due to some unknown error, exception or failure.诊断

变更历史

变更时间变更内容概要操作
2025-04-16
新增请求参数LifecycleHookContext
2024-10-16
新增请求参数StopInstanceTimeout
2024-05-21
新增请求参数IgnoreInvalidInstance
2022-09-09
新增OpenAPI,从一个伸缩组删除一台或多台实例

相关示例