获得云机分页
按条件分页查询云机列表。
接口地址:
text
/papi/container/page请求方式:
text
POST请求数据类型:
text
application/jsonHeader 参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| X-Access-Key | string | 是 | API 访问密钥 ID,鉴权方式见 接口规则 |
| X-Signature | string | 是 | 签名值,Base64 编码的 HMAC-SHA256 计算结果 |
| X-Timestamp | string | 是 | 毫秒级 Unix 时间戳(13 位) |
| X-Nonce | string | 是 | 随机字符串,10~32 位小写字母+数字 |
Body 参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| pageNo | integer | 否 | 页码,从 1 开始,默认 1 |
| pageSize | integer | 否 | 每页条数,最大值为 1000,默认 10 |
| name | string | 否 | 可以通过容器名称/云机备注/容器IP查询云机 |
| status | integer | 否 | 容器状态,枚举值:1-关机,2-开机中,3-重启中,4-关机中,5-重置中,6-删除中,7-运行中,8-已删除 |
| sortType | integer | 否 | 排序类型,枚举:1-设备名称升序,2-设备名称降序,3-设备时长升序,4-设备时长降序 |
| containerSidList | array[string] | 否 | 容器ID列表 |
| groupSid | string | 否 | 分组ID |
| aliasCode | string | 否 | 规格编码别称 |
| authType | integer | 否 | 授权类型,枚举:0-可授权,1-已授权出去,2-被授权 |
| os | integer | 否 | 安卓版本,参见 AndroidVersionEnum 枚举 |
| proxyIpUid | string | 否 | 代理IP的UID,用于过滤已绑定该IP的云机 |
| filterBoundContainers | boolean | 否 | 是否过滤已绑定的云机,true表示过滤已绑定的云机,false表示不过滤已绑定的云机 |
请求示例:
json
{
"pageNo": 1,
"pageSize": 10,
"status": 7
}响应参数:
| 参数 | 类型 | 说明 |
|---|---|---|
| code | integer | 错误码,参见 错误码说明 |
| data | object | 返回数据 |
| ├─ list | array[object] | 云机数据列表 |
| ├─├─ ctrId | string | 容器标识 |
| ├─├─ roleId | integer | 角色ID |
| ├─├─ name | string | 容器名称 |
| ├─├─ ctrNameId | string | 容器id业务主键 |
| ├─├─ autoRenewFlag | boolean | 是否自动续费 |
| ├─├─ share | boolean | 是否共享 |
| ├─├─ expire | integer | 过期时间(有效期) |
| ├─├─ status | integer | 状态 |
| ├─├─ ctrName | string | 容器名称 |
| ├─├─ ctrMobileModel | string | 型号 |
| ├─├─ ctrAlias | string | 容器别名 |
| ├─├─ remark | string | 云手机备注 |
| ├─├─ ctrRemark | string | 云手机备注 |
| ├─├─ ctrIp | string | 容器IP |
| ├─├─ bootstrapAt | integer | 启动时间 |
| ├─├─ stopAt | integer | 关闭时间 |
| ├─├─ authNum | integer | 授权人数 |
| ├─├─ groupName | string | 分组名称 |
| ├─├─ cphoneProxyHost | string | 代理IP |
| ├─├─ refreshCount | integer | 一键新机免费次数 |
| ├─├─ payRefreshCount | integer | 一键新机付费次数 |
| ├─├─ monthlyGiftCount | integer | 一键新机每月免费总次数 |
| ├─├─ dest | string | 设备IP加密字符串 |
| ├─├─ screenshotServiceUrl | string | 截图服务地址 |
| ├─├─ turnServerUri | string | 中继地址 |
| ├─├─ skuName | string | sku 名称 |
| ├─├─ skuCode | string | sku 编号 |
| ├─├─ aliasCode | string | 别名编码 |
| ├─├─ androidVersion | string | 安卓版本 |
| ├─├─ os | integer | 云机OS |
| ├─├─ level | integer | sku Level |
| ├─├─ packageCode | string | 套餐Code |
| ├─├─ fpSign | string | 云机操作接口鉴权签名 |
| ├─├─ topFlag | boolean | 是否置顶 |
| ├─├─ ossServiceApiUrl | string | OSS服务端API地址 |
| ├─├─ operateFlag | boolean | 是否操作权限 |
| ├─├─ authType | integer | 授权类型,0-普通,1-已授权,2-被授权 |
| ├─ total | integer | 数据总量 |
| msg | string | 错误提示 |
响应示例:
json
{
"code": 0,
"data": {
"list": [
{
"ctrId": "ctr-xxx",
"roleId": 0,
"name": "测试云机-01",
"ctrNameId": "ctrNameId-xxx",
"autoRenewFlag": false,
"share": false,
"expire": 1735689600000,
"status": 7,
"ctrName": "测试云机-01",
"ctrMobileModel": "SM-G9880",
"ctrAlias": "22d6sr1gii",
"remark": "备注",
"ctrRemark": "云机备注",
"ctrIp": "192.168.1.100",
"bootstrapAt": 1735689600000,
"stopAt": 0,
"authNum": 0,
"groupName": "默认分组",
"cphoneProxyHost": "",
"refreshCount": 10,
"payRefreshCount": 0,
"monthlyGiftCount": 10,
"dest": "encrypted-xxx",
"screenshotServiceUrl": "https://screenshot.example.com",
"turnServerUri": "turn:turn.example.com:3478",
"skuName": "标准版",
"skuCode": "standard",
"aliasCode": "std",
"androidVersion": "Android 12",
"os": 12,
"level": 1,
"packageCode": "pkg-xxx",
"fpSign": "sign-xxx",
"topFlag": false,
"ossServiceApiUrl": "https://oss.example.com",
"operateFlag": true,
"authType": 0
}
],
"total": 100
},
"msg": "success"
}