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

RemoveInstances - 从伸缩组手动删除实例

最近更新时间2024.05.16 10:34:05

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

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

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

RemoveInstances

要执行的操作,取值:RemoveInstances。

Version
String

2020-01-01

API的版本,取值:2020-01-01。

ScalingGroupId
String

scg-ybmssdnnhn5pkgyd****

伸缩组ID。您可以调用DescribeScalingGroups查询伸缩组ID。

RemoveMode
String

release

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

  • 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(默认):不触发。
ForceDelete
Boolean

false

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

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

true

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

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

i-ybmike5l70l8j1ha****

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

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
ScalingActivityId
String

sga-ybn0mwfy1yl8j1f6****

伸缩日志ID。

请求示例

GET /?Action=RemoveInstances&InstanceIds.1=i-ybmike5l70l8j1ha****&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240507T112809Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240507/cn-beijing/auto_scaling/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f


返回示例

{
  "ResponseMetadata": {
    "RequestId": "202405071928192410022181941EF6A7",
    "Version": "2020-01-01",
    "Service": "auto_scaling",
    "Region": "cn-beijing"
  },
  "Result": {
    "ScalingActivityId": "sga-ybn0mwfy1yl8j1f6****"
  }
}

错误码

您可访问公共错误码,获取更多错误码信息。