设置云主机保护
接口功能介绍
开始保护或者停止保护伸缩组内的一台或者多台云主机
接口约束
无
URI
POST /v4/scaling/group/set-instances-protection
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
groupID | 是 | Integer | 伸缩组ID | 472 | |
instanceIDList | 是 | Array of Integers | 实例ID列表 | [339] | |
protectStatus | 是 | Integer | 保护状态。取值范围:1:已保护。2:未保护。 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回码:800表示成功,900表示失败 | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码 | Scaling.Group.NotFound | 错误码 |
message | String | 失败时的错误描述,一般为英文描述 | scaling group info not found | |
description | String | 失败时的错误描述,一般为中文描述 | 未找到弹性伸缩组信息 | |
returnObj | Object | 成功时返回的数据,参见表returnObj | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceIDList | Array of Integers | 实例ID列表 | [339] |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"groupID": 489,
"protectStatus": 1,
"instanceIDList": [
339
]
}
响应示例
{
"returnObj": {
"instanceIDList": [
339
]
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
errorCode | 描述 |
---|---|
Scaling.Group.NotFound | 未找到弹性伸缩组信息 |
Scaling.Group.ProtectStatusNotSupported | 不支持该实例保护模式 |
Scaling.Group.IdListIsNone | 云主机列表为空 |
Scaling.Group.IdListTypeError | 云主机列表类型错误 |
Scaling.Group.IdListNotExit | 云主机列表不存在 |