
# 实例状态批量查询 - BatchQueryStatus
#### 功能介绍
实例状态批量查询。
调用此api的前提条件是租户需要先购买实例。
接口返回实例当前的状态。云机状态，0：未知，1：已停止，2：运行中，3：下线中，4：启动中，5：已关机。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/KooPhone/doc?api=BatchQueryStatus)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-koophone/kp_01_0009.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                                | 访问级别  | 资源类型（\*为必须）           | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | koophone:cloudphoneResource:queryBatchShowInstance | Write | cloudphoneResource \* | -   | -  | -      |
     
  
 
#### URI
POST /v1/instances/batch-query-status
#### 请求参数
表1请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述       |
|:---|:---|:---|:---|
| x-request-id | 是    | String | 消息跟踪唯一id |
| X-Auth-Token | 是    | String | 租户级Token |
   
表2请求Body参数 
| 参数           | 是否必选 | 参数类型             | 描述                        |
|:---|:---|:---|:---|
| instance_ids | 是    | Array of strings | 实例列表，单个实例最长32个字符，列表最长100列 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数         | 参数类型                                                                                      | 描述                              |
|:---|:---|:---|
| error_code | String                                                                                    | 响应码，错误码规范KooPhone.API.1001，数字递增 |
| error_msg  | String                                                                                    | 响应描述                            |
| data       | [StatusResultWrapper] object | 状态查询结果                          |
   
 表4StatusResultWrapper 
| 参数             | 参数类型                                                                                  | 描述     |
|:---|:---|:---|
| status_results | Array of [StatusResult] objects | 状态查询结果 |
   
 表5StatusResult 
| 参数          | 参数类型    | 描述                                                        |
|:---|:---|:---|
| instance_id | String  | 实例id                                                      |
| status      | Integer | 云机状态。0：空闲，1：恢复中，2：数据已加载，3：串流中，4：备份中，5：备份异常，6：恢复异常，7：数据已加载 |
   
**状态码：400**
表6响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                                                              |
|:---|:---|:---|
| error_code | String | 0：成功 KOOPHONE.API.1000：请求参数错误 KOOPHONE.API.1001：没有实例权限 KOOPHONE.API.9999：服务内部报错 |
| error_msg  | String | 错误信息                                                                                                                                                                                                                            |
   
**状态码：500**
表7响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                                                              |
|:---|:---|:---|
| error_code | String | 0：成功 KOOPHONE.API.1000：请求参数错误 KOOPHONE.API.1001：没有实例权限 KOOPHONE.API.9999：服务内部报错 |
| error_msg  | String | 错误信息                                                                                                                                                                                                                            |
   
#### 请求示例
```
/v1/instances/batch-query-status
{
  "instance_ids" : [ "a44uhlf7", "efjy72gs" ]
}
```
#### 响应示例
**状态码：200**
正常响应
```
{
  "data" : {
    "status_results" : [ {
      "instance_id" : "a44uhlf7",
      "status" : 0
    } ]
  },
  "error_code" : "0",
  "error_msg" : "ok"
}
```
#### 状态码
| 状态码 | 描述   |
|:---|:---|
| 200 | 正常响应 |
| 400 | 请求错误 |
| 500 | 内部错误 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-koophone/ErrorCode.html)。
