实例准备进度 - ShowProgress
功能介绍
实例准备进度。
调用此api的前提条件是需要先调用prepare接口。
循环调用此接口直到云机状态为正常则可开启串流。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v1/instances/prepare-progress
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-auth-token |
是 |
String |
租户的iam token信息 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
user_id |
是 |
String |
用户id，最大长度32个字符 |
|
instance_id |
是 |
String |
实例id，最大长度32个字符 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
实例准备进度响应 |
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
Integer |
实例准备状态。0：正常，1：排队中，2：还原中和离线，-1：处理失败，3：备份中 |
|
waitingCount |
Integer |
等待时间 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
0：成功 KOOPHONE.API.1000：请求参数错误 KOOPHONE.API.1001：没有实例权限 KOOPHONE.API.4001：实例不存在 KOOPHONE.API.9999：服务内部错误 |
|
error_msg |
String |
错误信息 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
内部错误 |
错误码
请参见错误码。
