实例批量查询 - ListInstances
功能介绍
实例批量查询。
调用此api的前提条件是租户需要先购买实例。
接口返回租户下所有实例信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
GET /v1/instances/batch-query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-request-id |
是 |
String |
消息跟踪唯一id |
|
page_no |
是 |
Integer |
分页页码 |
|
page_size |
是 |
Integer |
分页大小 |
|
instance_id |
否 |
String |
实例id |
|
instance_name |
否 |
String |
实例名称 |
|
query_start_time |
否 |
String |
查询开始时间，UTC时间，格式2023-08-15 14:30:45 |
|
query_end_time |
否 |
String |
查询结束时间，UTC时间，格式2023-08-15 14:30:45 |
|
pool_scene_tag |
否 |
String |
资源池场景标签。CLOUD_APP：云应用，CLOUD_PHONE：通用云终端 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
租户token |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
实例批量查询结果 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
Array of result objects |
实例批量查询结果列表 |
|
page_no |
Integer |
分页页码 |
|
page_size |
Integer |
每页条数 |
|
total_count |
Integer |
元素总数 |
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instance_id |
String |
实例id |
|
instance_name |
String |
实例名称 |
|
region |
String |
区域，实例：cn-north-4 |
|
instance_sku |
String |
实例规格。如专业版 | 8 核 | 16GB | 10GB 存储 | 最高分辨率 720p |
|
frozen_status |
Integer |
冻结状态。0：正常，1：已冻结 |
|
running_status |
Integer |
运行状态。0：未知，1：已停止，2：运行中，3：下线中，4：启动中，5：已关机 |
|
login_status |
Integer |
登录状态。0：未登录，1：已登录 |
|
assign_status |
Integer |
分配状态。0：未分配，1：已分配 |
|
assign_user |
String |
分配用户 |
|
billing_mode |
String |
计费模式 |
|
project_id |
String |
云机关联的租户项目id |
|
project_name |
String |
云机关联的租户项目名称 |
|
phone_id |
String |
实例id |
|
member_name |
String |
用户姓名 |
|
account_name |
String |
账号名 |
|
region_name |
String |
区域名称 |
|
region_name_en |
String |
英文区域名称 |
|
backup_status |
Integer |
备份状态。0：准备中，1：执行中，2：成功，3：失败，4：其他 |
|
backup_time |
String |
备份状态发生时间 |
|
restore_status |
Integer |
还原状态。0：准备中，1：执行中，2：成功，3：失败，4：其他 |
|
restore_time |
String |
还原状态发生时间 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
0：成功 KOOPHONE.API.1000：请求参数错误 KOOPHONE.API.1001：没有实例权限 KOOPHONE.API.1004：服务没有订阅 KOOPHONE.API.5002：时间请求格式错误 KOOPHONE.API.5004：查询结束日期小于查询起始日期 KOOPHONE.API.9999：服务内部报错 |
|
error_msg |
String |
错误响应描述 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
0：成功 KOOPHONE.API.0000：租户不存在 KOOPHONE.API.1000：请求参数错误 KOOPHONE.API.1001：没有实例权限 KPAPI.2209：没有可分配的设备 KOOPHONE.API.9999：服务内部错误 |
|
error_msg |
String |
响应描述 |
请求示例
/v1/instances/batch-query?page_no=1&page_size=200&poolSceneTag=CLOUD_PHONE
响应示例
状态码：200
实例批量查询正常响应
{
"data" : {
"result" : [ {
"instance_id" : "5srn5hL8",
"instance_name" : "CCTEST-00001",
"region" : "cn-north-7",
"instance_sku" : "专业版 | 8 核 | 16GB | 10GB 存储 | 最高分辨率 720p",
"frozen_status" : 0,
"running_status" : 1,
"login_status" : 0,
"assign_status" : 1,
"assign_user" : "1008600000097131912",
"billing_mode" : "1",
"project_id" : "9d71ec45aef04d84a991c12250227b5c",
"project_name" : "cn-north-7",
"phone_id" : "null",
"member_name" : "test",
"account_name" : "hhh@cs02.huaweiapaas.com",
"region_name" : "华北-乌兰察布-二零三",
"region_name_en" : "CN North-Ulanqab203",
"backup_status" : 0,
"backup_time" : "2024-05-24 17:34:58",
"restore_status" : 0,
"restore_time" : "2024-05-24 20:34:58"
} ]
},
"page_no" : 1,
"page_size" : 100,
"total_count" : 72,
"error_code" : "0",
"error_msg" : "OK"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
实例批量查询正常响应 |
|
400 |
请求错误 |
|
500 |
内部错误 |
错误码
请参见错误码。
