You need to enable JavaScript to run this app.
导航

RemoveInstances

最近更新时间2024.01.22 16:18:33

首次发布时间2022.05.13 10:42:45

调用 RemoveInstances 删除伸缩组中的实例,操作说明和注意事项请参见手动删除实例

请求参数

名字类型是否必填示例值
描述
ActionStringRemoveInstances要执行的操作,取值:RemoveInstances。
VersionString2020-01-01API的版本,取值为:2020-01-01。
ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****伸缩组ID。您可以调用DescribeScalingGroups查询伸缩组ID。

InstanceIds.N

String

InstanceIds.1=i-ybmike5l70l8j1ha****&
InstanceIds.2=i-ybmike5l70l8j1hi****

实例ID。您可以调用DescribeScalingInstances查询指定伸缩组中的实例ID。

  • 参数 - N:表示伸缩组的序号,取值1 ~ 20。
  • 多个实例ID之间用&分隔。

RemoveMode

String

recycle

手动删除实例的操作模式,取值:

  • release(默认):所选实例直接被释放。
  • recycle:所选实例转变为停机不计费状态。

说明

本参数仅当ScalingMode也为recycle时生效

具体实例的删除操作,和伸缩组的实例回收模式ScalingMode相关,您可以调用DescribeScalingGroups接口查询伸缩组的实例回收模式。

  • ScalingMode为release,RemoveMode为release:实例被释放。
  • ScalingMode为release,RemoveMode为recycle:实例被释放。
  • ScalingMode为recycle,RemoveMode为release:实例被释放。
  • ScalingMode为recycle,RemoveMode为recycle:实例转变为停机不计费状态。

LifecycleHook

Boolean

false

伸缩组删除实例时,是否触发缩容生命周期挂钩。取值:

  • true:触发。
  • false(默认):不触发。

DecreaseDesiredCapacity

Boolean

true

是否修改期望实例数,仅当所选伸缩组设置了期望实例数时有效。

  • true(默认):完成删除行为后,期望实例数会自动减少期望删除的实例数量。例如,原期望实例数为5个,选择删除2个实例,那么,完成删除行为后,期望实例数变更为3个。
  • false:期望实例数不变,完成删除行为后,再次执行健康检查时,伸缩组会自动扩容至期望实例数。

ForceDelete

Boolean

false

DecreaseDesiredCapacity参数取值false,且删除实例后伸缩组实例数小于最小实例数时,是否仍强制删除实例。取值:

  • false(默认):不强制删除。
  • true:强制删除。

返回数据

操作接口仅返回公共参数及错误码。

请求示例

GET /?Action=RemoveInstances&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&InstanceIds.1=i-ybmike5l70l8j1ha****&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: auto_scaling

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202204201736250102252430810428****",
        "Action": "RemoveInstances",
        "Version": "2020-01-01",
        "Service": "auto_scaling",
        "Region": "cn-beijing"
    },
    "Result": {}
}