查询伸缩组内云主机的列表,并列出云主机的信息
接口功能介绍
查询伸缩组内云主机的列表,并列出云主机的信息
接口约束
无
URI
POST /v4/scaling/group/query-instance-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
groupID | 是 | Integer | 伸缩组ID | 483 | |
pageNo | 否 | Integer | 页码 | 5 | |
pageSize | 否 | Integer | 分页查询时设置的每页行数,取值范围:[1~100],默认值为10 | 10 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceList | Array of Objects | 云主机信息列表 | instanceList | |
totalCount | Integer | 总计 | 1 |
表 instanceList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceID | String | 云主机ID | ||
regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
groupID | Integer | 伸缩组ID | 472 | |
zabbixName | String | 【Deprecated】监控设备ID | ||
projectIDEcs | String | 企业项目ID | ||
createDate | String | 创建时间 | 2022-10-09 14:40:32 | |
id | Integer | 实例ID | 316 | |
status | Integer | 伸缩活动状态。取值范围:1:已启用。2:正在移入。3:正在移出。 | 2 | |
instanceName | String | 云主机名称 | ||
executionMode | Integer | 执行方式。取值范围:1:自动执行策略。2:手动执行策略。3:手动移入实例。4:手动移出实例。5:新建伸缩组满足最小数。6:修改伸缩组满足最大最小限制。7:健康检查移入。8:健康检查移出。 | 3 | |
healthStatus | Integer | 健康检查状态。取值范围:1:正常。2:异常。3:初始化。 | 3 | |
configName | String | 伸缩配置名称 | as-config-a8ab | |
configID | String | 伸缩配置ID | 389 | |
activeID | Integer | 伸缩活动ID | 938 | |
protectStatus | Integer | 保护状态。取值范围:1:已保护。2:未保护。 | 2 | |
joinDate | String | 加入时间 | 2022-10-09 14:40:32 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"groupID": 472
}
响应示例
{
"returnObj": {
"instanceList": [
{
"instanceID": null,
"regionID": "81f7728662dd11ec810800155d307d5b",
"groupID": 472,
"zabbixName": null,
"projectIDEcs": "",
"createDate": "2022-10-09 14:40:32",
"id": 316,
"status": 2,
"instanceName": "",
"configName": "as-config-a8ab",
"executionMode": 5,
"healthStatus": null,
"configID": 389,
"activeID": 938,
"protectStatus": 2,
"joinDate": "2022-10-09 14:40:32"
}
],
"totalCount": 1
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
errorCode | 描述 |
---|---|
Scaling.Group.NotFound | 未找到弹性伸缩组信息 |