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

DetachInstances

最近更新时间2023.08.28 16:18:12

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

调用 DetachInstances 从伸缩组中移出一个或者多个实例,操作说明和注意事项请参见手动移出实例

请求参数

名字类型是否必填示例值
描述
ActionStringDetachInstances要执行的操作,取值:DetachInstances。
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之间用&分隔。

DecreaseDesiredCapacity

Boolean

true

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

  • true(默认):完成移出行为后,期望实例数会自动修改为伸缩组中实际的实例数量。
  • false:期望实例数不变,完成移出行为后,再次执行健康检查时,伸缩组会自动扩容至期望实例数。

LifecycleHook

Boolean

false

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

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

DetachOption

String

both

是否取消实例与负载均衡以及公网IP的关联,取值:

  • both(默认):解除关联后,实例将自动从负载均衡中移出,并自动删除公网IP资源。
  • none:不取消关联。

返回数据

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

请求示例

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

返回示例

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