接口功能介绍
该接口提供用户多台云主机状态信息查询功能，用户可以根据此接口的返回值得到多台云主机的状态信息。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
分页查询：当前查询结果以分页形式进行展示，单次查询最多显示50条数据
匹配查找：可以通过部分字段进行匹配筛选数据，无符合条件的为空，在指定多台云主机ID的情况下，只返回匹配到的云主机信息。推荐每次使用单个条件查找
接口约束
无
URI
POST /v4/ecs/instance-status-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| azName | 否 | String | 可用区名称，您可以查看地域和可用区来了解可用区 获取： 查 资源池可用区查询 注：查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空（即为单可用区，本字段填写default） |
cn-huadong1-jsnj1A-public-ctcloud | |
| instanceIDList | 否 | String | 云主机ID列表，多台使用英文逗号分割，您可以查看弹性云主机了解云主机的相关信息 获取：创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
73f321ea-62ff-11ec-a8bc-005056898fe0,88f888ea-88ff-88ec-a8bc-888888888fe8 | |
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 10 | |
| projectID | 否 | String | 企业项目ID，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。您可以通过查看创建企业项目了解如何创建企业项目 | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceID | String | 云主机ID | 5ae83d07-0389-22fd-def8-995090ee3d5a | |
| instanceStatus | String | 云主机状态，取值范围： backuping: 备份中， creating: 创建中， expired: 已到期， freezing: 已冻结， rebuild: 重装， restarting: 重启中， running: 运行中， starting: 开机中， stopped: 已关机， stopping: 关机中， error: 错误， snapshotting: 快照创建中， unsubscribed: 包周期已退订， unsubscribing: 包周期退订中。 更多云主机状态请通过状态枚举值查看云主机使用状态 |
running |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1：指定每页记录数目，指定页云主机信息<br/>
华东1指定每页记录数目为3，查看第2页云主机状态信息
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"pageNo": 2,
"pageSize": 3
}
示例2：在多可用区类型资源池，查看单个可用区下的云主机信息
华东1可用区2指定每页记录数目为5，查看第3页的云主机状态信息
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"azName": "cn-huadong1-jsnj1A-public-ctcloud",
"pageNo": 3,
"pageSize": 5
}
示例3：查看指定云主机ID的多个云主机的状态
查看华东1中查找ID为c5a7966a-88e7-362b-6e11-c2d8fbfc07ca和adc614e0-e838-d73f-0618-a6d51d09070a的云主机状态信息
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceIDList": "c5a7966a-88e7-362b-6e11-c2d8fbfc07ca,adc614e0-e838-d73f-0618-a6d51d09070a"
}
示例4：查找指定企业项目下的云主机状态
查找在华东1资源池下，企业项目ID为6732237e53bc4591b0e67d750030ebe3的云主机信息
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"projectID": "6732237e53bc4591b0e67d750030ebe3"
}
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"totalPage": 1,
"statusList": [{
"instanceID": "eea3fb7f-7430-8348-319a-78d00616a7d9",
"instanceStatus": "running"
}, {
"instanceID": "b3721e53-7d5c-52d4-4572-581b5abe7807",
"instanceStatus": "running"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
