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

DetachInstances - 从伸缩组手动移出实例

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

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

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

调试

请求参数

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

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

DetachInstances

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

Version
String

2020-01-01

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

ScalingGroupId
String

scg-ybmssdnnhn5pkgyd****

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

LifecycleHook
Boolean

false

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

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

true

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

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

both

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

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

i-ybmike5l70l8j1ha****

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

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

返回参数

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

参数
类型
示例值
描述
ScalingActivityId
String

sga-ybn0mwfy1yl8j1f6****

伸缩日志ID。

请求示例

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


返回示例

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

错误码

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