解绑伸缩组云服务器

最近更新时间:2019-12-03 21:44:12

1. 接口描述

本接口(DetachInstance)用于从指定的伸缩组移出 CVM 实例。
接口请求域名:

scaling.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的 Action 字段为 DetachInstance。

  • 若移出的 CVM 实例为用户手动创建的时候,不会停止和释放该实例。
  • 当伸缩组为生效(active)状态,才可以执行此功能。
  • 当伸缩组没有伸缩活动正在执行,才可以调用该接口。
  • 当伸缩组没有伸缩活动正在执行时,该功能可以绕过冷却时间(Cooldown)直接执行。
  • 如果当前伸缩组的实例数减去该接口指定的实例数小于伸缩组规定的最小伸缩数时,则调用失败。
  • 移出的 CVM 实例会与伸缩组关联的负载均衡监听器解绑。
参数名称 是否必选 类型 描述
scalingGroupId String 待移出 CVM 实例的伸缩组 ID,可调用 查询伸缩组列表(DescribeScalingGroup)接口查询。
instanceIds.n String 伸缩组中待移出的 CVM 实例 ID,请填写 查询伸缩组绑定的云服务器(DescribeScalingInstance)接口中返回的 instanceId(服务器统一 ID)字段。
keepInstance Int 是否保留移出的 CVM 实例,取值范围:
0:表示移出 CVM 实例时销毁实例。
1:表示移出 CVM 实例时保留此实例。
默认取值:0。

3. 输出参数

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因。
message String 模块错误信息描述,与接口相关。

4. 错误码

以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 AS 错误码

错误码 描述
InvalidParameter.ScalingGroupIdError scalingGroupId 不正确
InvalidParameter.InstanceIdError instanceId 不正确

5. 示例

https://scaling.api.qcloud.com/v2/index.php?
&<公共请求参数>
&scalingGroupId=xxx
&instanceIds.0=ins-xxxx
&instanceIds.1=ins-xxxx

返回示例如下,code为0,表示成功解绑。

{
    "code":"0",
    "message":"", 
    "codeDesc":"Success"   
}
目录