云手机服务 KooPhone
云手机服务 KooPhone
链接复制成功！
实例状态批量查询
功能介绍
实例状态批量查询。
调用此api的前提条件是租户需要先购买koophone云手机实例。
接口返回实例当前的状态：云机状态，0：未知，1： 已停止，2：运行中，3：下线中，4：启动中， 5：已关机。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/instances/batch-query-status
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-request-id |
是 |
String |
消息跟踪唯一id |
|
X-Auth-Token |
是 |
String |
租户级Token |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_ids |
是 |
Array of strings |
实例列表 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码，错误码规范KooPhone.API.1001，数字递增 |
|
error_msg |
String |
响应描述 |
|
data |
StatusResultWrapper object |
状态查询结果 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instance_id |
String |
实例id |
|
status |
Integer |
云机状态，0：未知，1： 已停止，2：运行中，3：下线中，4：启动中， 5：已关机 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码，KOOPHONE.API.xxxx或者common.00000xxx |
|
error_msg |
String |
响应描述 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码，KOOPHONE.API.xxxx或者common.00000xxx |
|
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 |
内部错误 |
错误码
请参见错误码。
父主题： 实例管理
