接口说明
分页查询云手机列表,列表按照云手机创建时间降序排列。分页查询支持模糊查询镜像版本imgVersion。若不存在已订购的云机,则返回空列表。
URL
POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/list
请求参数
Header
|
参数名称
|
类型
|
必填
|
描述
|
|
pool
|
string
|
否
|
资源池ID |
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
req
|
OpenapiCloudPhonePageReq
|
是
|
req |
|
currentPage
|
integer(int32)
|
否
|
页码,默认为1 |
|
hostIp
|
string
|
否
|
服务器公网IP |
|
id
|
string
|
否
|
云手机ID |
|
ids
|
<string> array
|
否
|
云手机ID列表 |
|
imgVersion
|
string
|
否
|
镜像版本,支持模糊查询 |
|
name
|
string
|
否
|
云手机名称 |
|
nameOrId
|
string
|
否
|
云手机名称或者编号 |
|
orderNos
|
<string> array
|
否
|
订单编号列表 |
|
osName
|
string
|
否
|
操作系统名称 |
|
pageSize
|
integer(int32)
|
否
|
每页条数,默认为10,最大值为100 |
|
prepareType
|
integer(int32)
|
否
|
预置备版本类型(1政企版、2公众版、3行业版、4专属版、5尊享版、8办公版、9矩阵版) |
|
specs
|
string
|
否
|
云手机规格 |
|
specsList
|
<string> array
|
否
|
云手机规格列表 |
|
status
|
integer(int32)
|
否
|
云手机状态(0已禁用、1正在开通、2运行中、3已关机、4已冻结、5已过期、6正在启动、7正在关机、8正在重启、9正在初始化、10 停用、99、异常) |
请求示例
POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/list
{
"pageSize":10,
"currentPage":1
}
返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
EPage«ZhPhoneDto»
|
响应体 |
|
list
|
<ZhPhoneDto> array
|
当前页数据 |
|
bindStatus
|
integer(int32)
|
绑定状态 |
|
endTime
|
string(date-time)
|
到期时间 |
|
errorMsg
|
string
|
错误信息,状态为99时使用 |
|
fps
|
integer(int32)
|
容器出流每秒帧数 |
|
hostId
|
string
|
主机ID |
|
hostIp
|
string
|
服务器公网IP |
|
id
|
string
|
云手机ID |
|
imgId
|
string
|
镜像Id |
|
imgParentId
|
string
|
父镜像ID |
|
imgVersion
|
string
|
镜像版本 |
|
maxBandwidth
|
integer(int32)
|
云机带宽上限Mbps |
|
mutexKick
|
string
|
云机互踢 0:不互踢 1:互踢 |
|
name
|
string
|
云手机名称 |
|
orderBatchNo
|
string
|
订单批次编号(MOP-O) |
|
orderNo
|
string
|
订单编号(MOP-T) |
|
osName
|
string
|
系统名称 |
|
podId
|
string
|
容器ID |
|
podName
|
string
|
容器名称 |
|
poolId
|
string
|
资源池ID |
|
prepareType
|
integer(int32)
|
预置备版本类型(1政企版、2公众版、3行业版、4专属版、5尊享版、6云车机版、7轻量版、8办公版、9矩阵版) |
|
remark
|
string
|
云机备注名 |
|
resolution
|
string
|
容器分辨率 |
|
resolutionHeight
|
string
|
分辨率高度 |
|
resolutionWidth
|
string
|
分辨率宽度 |
|
screenshotPrefix
|
string
|
截图前缀 |
|
screenshotUrl
|
string
|
截屏链接 |
|
signalUrl
|
string
|
信令地址 |
|
specType
|
integer(int32)
|
云手机规格类型:1-办公型,2-娱乐型 |
|
specs
|
string
|
云手机规格 |
|
specsName
|
string
|
云手机规格名称 |
|
startTime
|
string(date-time)
|
开通时间 |
|
status
|
integer(int32)
|
云手机状态(0已禁用、1正在开通、2运行中、3已关机、4已冻结、5已过期、6正在启动、7正在关机、8正在重启、9正在初始化、99异常) |
|
userId
|
string
|
用户ID |
|
volumeId
|
string
|
绑定的云硬盘ID |
|
webrtcMinBandwidth
|
integer(int32)
|
WebRTC带宽下限Mbps |
|
total
|
integer(int64)
|
结果总数量 |
|
totalPage
|
integer(int32)
|
结果总页数 |
|
errorCode
|
string
|
错误编码 |
|
errorMessage
|
string
|
错误信息 |
|
requestId
|
string
|
请求id |
|
state
|
string
|
状态值 |
返回示例
{
"errorCode":"00000000",
"errorMessage":"请求成功",
"requestId":"ce2af272-8e7a-49ba-aef0-1487fe74b284",
"state":"OK",
"body":{
"total":1,
"totalPage":1,
"list":[
{
"id":"1899654129611276290",
"name":"cp-b8db7408684c48d885c95d748bb5942b",
"status":3,
"specs":"2406131734452992",
"bandwidth":null,
"userId":"CIDC-U-7f8eb589e43948ce9c3df26124d603fe",
"poolId":null,
"imgVersion":"image_3.3.4",
"imgId":"99",
"osName":"aosp11",
"startTime":"2025-03-12 10:50:08",
"endTime":"2025-04-12 10:50:08",
"orderNo":null,
"errorMsg":null,
"podId":"1899651767307960322",
"podName":"pod-4bzb-e7668b34e24542c08d3185626733f745",
"hostId":"1811707545332031490",
"hostIp":"10.251.137.225",
"volumeId":"d3fb433d-b910-4297-854e-531acc297cd9",
"resolutionWidth":"720",
"resolutionHeight":"1280",
"bindStatus":0,
"prepareType":4,
"specsName":"标准版(2C4G 32G存储)",
"specType":1,
"screenshotPrefix":null,
"screenshotUrl":null,
"mutexKick":null,
"remark":null,
"fps":null,
"resolution":null,
"signalUrl":"wss://ecloud.10086.cn:31015/api/query/zycloudphone/ws/signal"
}
]
}
}