接口功能介绍
该接口提供用户多台云主机状态信息查询功能，用户可以根据此接口的返回值得到多台云主机的状态信息。
接口约束
- 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
URI
GET /v4/ecs/status-list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以调用查询账户启用的资源池信息查看最新的天翼云资源池列表 | bb9fdb42056f11eda1610242ac110002 | |
| azName | 否 | String | 可用区名称。您可以调用资源池可用区查询获取可用区信息，查询结果中zoneList内返回存在可用区名称（即多a可用区，本字段填写实际可用区名称），若查询结果中zoneList为空（即为单可用区，本字段填写default）。 | cn-huadong1-jsnj1A-public-ctcloud | |
| instanceIDList | 否 | String | 云主机ID列表，多台使用英文逗号分割（不填则返回所有云主机状态信息） | 5ae83d07-0389-22fd-def8-995090ee3d5a,1d371359-7378-7d51-69bd-fd5c1c40cddd | |
| projectID | 否 | String | 企业项目ID | 0 | |
| pageNo | 否 | String | 页码，取值范围：大于等于1，默认值为1 | 1 | |
| pageSize | 否 | String | 每页记录数目，取值范围:[1~50]，默认值为10，单页最大记录不超过50 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| statusList | Array of Objects | 分页明细 | statusList |
表 statusList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ID | String | 主机id | 8a88dacd-88c8-f888-8f88-d88d88d8888a | |
| status | String | 云主机状态，取值范围： backingup: 备份中， creating: 创建中， expired: 已到期， freezing: 冻结中， rebuild: 重装， restarting: 重启中， running: 运行中， starting: 开机中， stopped: 已关机， stopping: 关机中 |
running |
枚举参数
无
请求示例
请求url
GET .../v4/ecs/status-list?regionID=81f7728662dd11ec810800155d307d5b&azName=az1&instanceIDList=5ae83d07-0389-22fd-def8-995090ee3d5a,1d371359-7378-7d51-69bd-fd5c1c40cddd&pageNo=1&pageSize=10
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"totalPage": 1,
"statusList": [{
"status": "running",
"ID": "5ae83d07-0389-22fd-def8-995090ee3d5a"
}, {
"status": "stopped",
"ID": "1d371359-7378-7d51-69bd-fd5c1c40cddd"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode ": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
