绑定伸缩组云服务器

最近更新时间:2018-08-21 16:16:37

1. 接口描述

本接口(AttachInstance)用于向指定的伸缩组添加CVM实例。
接口请求域名:

scaling.api.qcloud.com

1)加入的CVM实例有以下几点限定条件:
加入的CVM实例必须与伸缩组在同一个地域。
加入的CVM实例的状态必须是“运行”状态。
加入的CVM实例不能已加入到其它伸缩组中。

2)当伸缩组为生效(active)状态,才可以执行此功能。

3)当伸缩组没有伸缩活动正在执行,才可以执行此功能。

4)当伸缩组没有伸缩活动正在执行时,该功能可以绕过冷却时间(Cooldown)直接执行。

5)如果该功能指定的实例数加上当前伸缩组的实例数大于该伸缩组规定的最大伸缩数时,则调用失败。

6)手工添加的CVM实例不与伸缩组生效的伸缩配置进行关联。

2. 输入参数

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

参数名称 是否必选 类型 描述
scalingGroupId String 待绑定CVM实例的伸缩组ID,可调用查询伸缩组列表(DescribeScalingGroup)接口查询。
instanceIds.n String 待绑定的CVM实例ID,请填写查询实例列表(DescribeInstances)接口中返回的unInstanceId(服务器统一ID)字段,一个伸缩组最多可绑定20个CVM实例。

3. 输出参数

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

4. 错误码

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

错误码 描述
IncorrectInstanceStatus.InOtherScalingGroup 云服务器已在其他伸缩组中绑定
InvalidParameter.ScalingGroupIdError scalingGroupId不正确
InvalidParameter.InstanceIdError instanceId不正确
InvalidInstanceId.ScallingConfigurationMismatch 绑定的云服务器与伸缩组配置不匹配
InvalidParameter.InvalidProjectId 资源所属的项目ID不是默认项目

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"   
}