启停伸缩组

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

接口描述

本接口(EnabledScalingGroup)用于启用或停止伸缩组。
接口请求域名:

scaling.api.qcloud.com

设置了停用伸缩组后,自动触发的活动不会进行,但是伸缩组的限制还生效。

当设置了停用伸缩组后,伸缩组将停止以下自动进行的活动:

  • 告警伸缩
  • 定时任务
  • 健康检查
  • 匹配期望实例数

输入参数

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

参数名称 必选 类型 描述
scalingGroupId String 待设置移除保护子机所在的伸缩组 Id,该参数可调用 查询伸缩组列表 (DescribeScalingGroup)接口查询。
enabledScalingGroup Int 伸缩组启停状态标志位,取值范围如下:
0:停止伸缩组
1:启用伸缩组

输出参数

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

错误码

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

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

示例

输入

https://scaling.api.qcloud.com/v2/index.php?
&<公共请求参数>
&scalingGroupId=asg-nrkpzopf
&enabledScalingGroup=1

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": []
}