# 实例准备进度 - ShowProgress
#### 功能介绍
实例准备进度。
调用此api的前提条件是需要先调用prepare接口。
循环调用此接口直到云机状态为正常则可开启串流。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/KooPhone/doc?api=ShowProgress)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-koophone/kp_01_0009.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                                    | 访问级别 | 资源类型（\*为必须）           | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | koophone:cloudphoneResource:getInstancePrepareProgress | Read | cloudphoneResource \* | -   | -  | -      |
     
  
 
#### URI
POST /v1/instances/prepare-progress
#### 请求参数
表1请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述             |
|:---|:---|:---|:---|
| x-auth-token | 是    | String | 租户的iam token信息 |
   
表2请求Body参数 
| 参数          | 是否必选 | 参数类型   | 描述             |
|:---|:---|:---|:---|
| user_id     | 是    | String | 用户id，最大长度32个字符 |
| instance_id | 是    | String | 实例id，最大长度32个字符 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数         | 参数类型                                                       | 描述       |
|:---|:---|:---|
| data       | [data]object | 实例准备进度响应 |
| error_code | String                                                     | 错误码      |
| error_msg  | String                                                     | 错误描述     |
   
 表4data 
| 参数           | 参数类型    | 描述                                       |
|:---|:---|:---|
| status       | Integer | 实例准备状态。0：正常，1：排队中，2：还原中和离线，-1：处理失败，3：备份中 |
| waitingCount | Integer | 等待用户数量                                   |
   
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| error_code | String | 0：成功 KOOPHONE.API.1000：请求参数错误 KOOPHONE.API.1001：没有实例权限 KOOPHONE.API.4001：实例不存在 KOOPHONE.API.9999：服务内部错误 |
| error_msg  | String | 错误信息                                                                                                                                                                                                                                                                                                    |
   
**状态码：500**
表6响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| error_code | String | 0：成功 KOOPHONE.API.1000：请求参数错误 KOOPHONE.API.1001：没有实例权限 KOOPHONE.API.4001：实例不存在 KOOPHONE.API.9999：服务内部错误 |
| error_msg  | String | 错误信息                                                                                                                                                                                                                                                                                                    |
   
#### 请求示例
```
/v1/instances/prepare-progress
{
  "user_id" : "1008600000104285462",
  "instance_id" : "iRJEVP9"
}
```
#### 响应示例
**状态码：200**
正常响应
```
{
  "data" : {
    "status" : 0,
    "waitingCount" : 0
  },
  "error_code" : "0",
  "error_msg" : "OK"
}
```
#### 状态码
| 状态码 | 描述   |
|:---|:---|
| 200 | 正常响应 |
| 400 | 请求错误 |
| 500 | 内部错误 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-koophone/ErrorCode.html)。