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

接口说明

  • 调用该接口前,请确保满足以下条件:

    • 目标伸缩组必须处于启用(Enable)状态。
    • 目标伸缩组没有正在进行的伸缩活动。
    说明 目标伸缩组没有正在进行的伸缩活动时,该接口可以绕过冷却时间直接触发伸缩活动。
  • 使用该接口,您需要注意以下事项:

    • 移出 ECS 实例、ECI 实例或托管实例之后,该实例可以独立于伸缩组而单独存在,您可以调用 AttachInstances 接口将 ECS 实例、ECI 实例或托管实例再次添加到其他伸缩组。
    • 调用该接口移出一台 ECS 实例、ECI 实例或托管实例并不会停止或释放该实例。
    • 接口成功调用后,仅表示弹性伸缩服务接受了该接口调用的请求。可以正常触发伸缩活动,但不能保证伸缩活动执行成功,您需要通过返回的 ScalingActivityId 查看伸缩活动的状态。
    • 目标伸缩组的 ECS 实例、ECI 实例或托管实例数量减去当前移出的 ECS 实例、ECI 实例或托管实例数量不能小于伸缩组最小实例数(MinSize),否则会报错。

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
ScalingGroupIdstring

伸缩组的 ID。

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

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

示例值:true
DetachOptionstring

指定是否停止使用 ECS 实例或 ECI 实例作为负载均衡实例的后端服务器(即将 ECS 实例或 ECI 实例移出负载均衡实例的默认服务器组和虚拟服务器组),以及是否将 ECS 实例或 ECI 实例移出 RDS 实例的访问白名单。展开详情

示例值:both
InstanceIdsarray<string>

待移出 ECS 实例、ECI 实例或托管实例的 ID。

子级条数 <= 100
LifecycleHookboolean

伸缩组移出 ECS 实例或 ECI 实例时,是否触发缩容生命周期挂钩。取值范围:展开详情

示例值:false
IgnoreInvalidInstanceboolean

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

示例值:false
ClientTokenstring

保证请求幂等性。展开详情

示例值:123e4567-e89b-12d3-a456-42665544****

返回参数

字段名称字段详情
ScalingActivityIdstring

伸缩活动的 ID。

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

请求 ID。

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

返回示例

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-21
新增请求参数IgnoreInvalidInstance
2022-09-09
新增OpenAPI,从一个伸缩组移出一台或多台实例

相关示例