Skip to content

获得云机分页 ​

按条件分页查询云机列表。

接口地址:

text
/papi/container/page

请求方式:

text
POST

请求数据类型:

text
application/json

Header 参数:

参数类型必填说明
X-Access-Keystring是API 访问密钥 ID,鉴权方式见 接口规则
X-Signaturestring是签名值,Base64 编码的 HMAC-SHA256 计算结果
X-Timestampstring是毫秒级 Unix 时间戳(13 位)
X-Noncestring是随机字符串,10~32 位小写字母+数字

Body 参数:

参数类型必填说明
pageNointeger否页码,从 1 开始,默认 1
pageSizeinteger否每页条数,最大值为 1000,默认 10
namestring否可以通过容器名称/云机备注/容器IP查询云机
statusinteger否容器状态,枚举值:1-关机,2-开机中,3-重启中,4-关机中,5-重置中,6-删除中,7-运行中,8-已删除
sortTypeinteger否排序类型,枚举:1-设备名称升序,2-设备名称降序,3-设备时长升序,4-设备时长降序
containerSidListarray[string]否容器ID列表
groupSidstring否分组ID
aliasCodestring否规格编码别称
authTypeinteger否授权类型,枚举:0-可授权,1-已授权出去,2-被授权
osinteger否安卓版本,参见 AndroidVersionEnum 枚举
proxyIpUidstring否代理IP的UID,用于过滤已绑定该IP的云机
filterBoundContainersboolean否是否过滤已绑定的云机,true表示过滤已绑定的云机,false表示不过滤已绑定的云机

请求示例:

json
{
  "pageNo": 1,
  "pageSize": 10,
  "status": 7
}

响应参数:

参数类型说明
codeinteger错误码,参见 错误码说明
dataobject返回数据
├─ listarray[object]云机数据列表
├─├─ ctrIdstring容器标识
├─├─ roleIdinteger角色ID
├─├─ namestring容器名称
├─├─ ctrNameIdstring容器id业务主键
├─├─ autoRenewFlagboolean是否自动续费
├─├─ shareboolean是否共享
├─├─ expireinteger过期时间(有效期)
├─├─ statusinteger状态
├─├─ ctrNamestring容器名称
├─├─ ctrMobileModelstring型号
├─├─ ctrAliasstring容器别名
├─├─ remarkstring云手机备注
├─├─ ctrRemarkstring云手机备注
├─├─ ctrIpstring容器IP
├─├─ bootstrapAtinteger启动时间
├─├─ stopAtinteger关闭时间
├─├─ authNuminteger授权人数
├─├─ groupNamestring分组名称
├─├─ cphoneProxyHoststring代理IP
├─├─ refreshCountinteger一键新机免费次数
├─├─ payRefreshCountinteger一键新机付费次数
├─├─ monthlyGiftCountinteger一键新机每月免费总次数
├─├─ deststring设备IP加密字符串
├─├─ screenshotServiceUrlstring截图服务地址
├─├─ turnServerUristring中继地址
├─├─ skuNamestringsku 名称
├─├─ skuCodestringsku 编号
├─├─ aliasCodestring别名编码
├─├─ androidVersionstring安卓版本
├─├─ osinteger云机OS
├─├─ levelintegersku Level
├─├─ packageCodestring套餐Code
├─├─ fpSignstring云机操作接口鉴权签名
├─├─ topFlagboolean是否置顶
├─├─ ossServiceApiUrlstringOSS服务端API地址
├─├─ operateFlagboolean是否操作权限
├─├─ authTypeinteger授权类型,0-普通,1-已授权,2-被授权
├─ totalinteger数据总量
msgstring错误提示

响应示例:

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"
}

OpenAPI Docs