OpenAPI 文档
OpenAPI 提供标准 HTTP 接口,用于管理云手机实例、任务和相关资源。
接口列表
应用管理
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 批量删除应用 | POST | /papi/application/batch/delete | 批量删除应用 |
| 删除应用 | POST | /papi/application/delete | 删除应用 |
| 获取应用标签 | POST | /papi/application/getAppTags | 获取应用标签 |
| 获取云机已安装应用集合 | POST | /papi/application/getInstallAppList | 获取云机已安装应用集合 |
| 获取市场应用分页 | POST | /papi/application/getApplicationPage | 获取市场应用分页 |
| 查看可预装应用数量 | POST | /papi/application/getPreInstallCount | 查看可预装应用数量 |
| 修改是否预安装状态 | POST | /papi/application/updatePreinstalledFlag | 修改是否预安装状态 |
| 获取团队应用分页 | POST | /papi/application/getTeamApplicationPage | 获取团队应用分页 |
云机管理
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 批量延长ADB过期时间 | POST | /papi/container/extendAdbExpire | 批量延长ADB过期时间 |
| 关闭ADB开关 | POST | /papi/container/closeOpenAdb | 关闭ADB开关 |
| 开启ADB开关 | POST | /papi/container/updateOpenAdb | 开启ADB开关 |
| 获取ADB账号 | POST | /papi/container/getAdbAccountList | 获取ADB账号 |
| 获得全部云机列表 | POST | /papi/container/all-container | 获得全部云机列表 |
| 获取品牌机型 | POST | /papi/container/model | 获取品牌机型 |
| 根据ctrAlias查询单台云机信息 | POST | /papi/container/getContainer | 根据ctrAlias查询单台云机信息 |
| 获得云机群控列表 | POST | /papi/container/containerList | 获得云机群控列表 |
| 获取云机分组树 | POST | /papi/container/group-tree | 获取云机分组树 |
| 获得云机分页 | POST | /papi/container/page | 获得云机分页 |
| 钱包-获取云机信息 | POST | /papi/container/getCloudInfo | 钱包-获取云机信息 |
| 修改云机名称 | POST | /papi/container/updateContainer | 修改云机名称 |
云机操作
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 批量更换机型 | POST | /papi/container/operate/batch/changeModel | 批量更换机型 |
| 批量关闭应用 | POST | /papi/container/operate/stopApp | 批量关闭应用 |
| 批量关闭云机代理 | POST | /papi/container/operate/batch/stopProxy | 批量关闭云机代理 |
| 批量获取云机连接配置 | POST | /papi/container/operate/batch/getConnectConfig | 批量获取云机连接配置 |
| 批量获取云机截图 | POST | /papi/container/operate/batch/screenReal | 批量获取云机截图 |
| 批量获取实例状态 | POST | /papi/container/operate/batch/getInstanceStatus | 批量获取实例状态 |
| 批量获取云机缩略图 | POST | /papi/container/operate/batch/screenshot | 批量获取云机缩略图 |
| 批量输入剪切板内容 | POST | /papi/container/operate/batch/inputCommitText | 批量输入剪切板内容 |
| 批量云机安装应用 | POST | /papi/container/operate/install-pkg | 批量云机安装应用 |
| 批量云机安装批量应用(异步) | POST | /papi/container/operate/batch/async/installPkg | 批量云机安装批量应用(异步) |
| 批量启动应用 | POST | /papi/container/operate/startApp | 批量启动应用 |
| 批量重启云机 | POST | /papi/container/operate/batch/restart | 批量重启云机 |
| 批量重置云机 | POST | /papi/container/operate/batch/reset | 批量重置云机 |
| 云机批量重启应用 | POST | /papi/container/operate/batch/restartApp | 云机批量重启应用 |
| 批量设置云机分辨率 | POST | /papi/container/operate/setDisplay | 批量设置云机分辨率 |
| 批量云机设置多个应用的root权限 | POST | /papi/container/operate/batch/setRootApp | 批量云机设置多个应用的root权限 |
| 批量卸载应用 | POST | /papi/container/operate/uninstallApp | 批量卸载应用 |
| 批量云机卸载批量应用 | POST | /papi/container/operate/batch/uninstallApps | 批量云机卸载批量应用 |
| 连接云机 | POST | /papi/container/operate/getConnectConfig | 连接云机 |
| 关闭云机代理 | POST | /papi/container/operate/stopProxy | 关闭云机代理 |
| 云机文件下载到本地 | POST | /papi/container/operate/fileDownLoad | 云机文件下载到本地 |
| 查看云机参数 | POST | /papi/container/operate/getContainerInfo | 查看云机参数 |
| 获取云机经纬度信息 | POST | /papi/container/operate/getPositioningInfo | 获取云机经纬度信息 |
| 获取云机代理信息 | POST | /papi/container/operate/getConfigureProxy | 获取云机代理信息 |
| 获取云机截图 | POST | /papi/container/operate/getScreenReal | 获取云机截图 |
| 获取实例状态 | POST | /papi/container/operate/getInstanceStatus | 获取实例状态 |
| 多云机关闭多个应用 | POST | /papi/container/operate/batch/stopApp | 多云机关闭多个应用 |
| 多云机启动多个应用 | POST | /papi/container/operate/batch/startApp | 多云机启动多个应用 |
| 多云机批量重启多个应用 | POST | /papi/container/operate/batch/batch-restartApp | 多云机批量重启多个应用 |
| 重启云机 | POST | /papi/container/operate/restartContainer | 重启云机 |
| 一键新机 | POST | /papi/container/operate/batch/quickNew | 一键新机 |
| 重置云机 | POST | /papi/container/operate/resetContainer | 重置云机 |
| 设置云机代理 | POST | /papi/container/operate/startProxy | 设置云机代理 |
| 执行 Shell 命令 | POST | /papi/container/operate/executeShell | 执行 Shell 命令 |
| 修改云机参数 | POST | /papi/container/operate/startGps | 修改云机参数 |
| 上传二维码图片 | POST | /papi/container/operate/uploadQrcodeImage | 上传二维码图片 |
云手机报障
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 创建云手机报障 | POST | /papi/fault-reports/create | 提交云手机故障工单 |
文件管理
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 批量删除文件 | POST | /papi/file/batch/delete | 批量删除文件 |
| 异步推送多个文件到多个云手机 | POST | /papi/file/asyncUploadContainersFiles | 异步推送多个文件到多个云手机 |
| 推送多个文件到多个云手机 | POST | /papi/file/uploadContainersFiles | 推送多个文件到多个云手机 |
| 取消上传文件 | POST | /papi/file/upload/cancel | 取消上传文件 |
| 删除文件 | POST | /papi/file/delete | 删除文件 |
| 获取云盘基础信息 | POST | /papi/file/cloudDisk | 获取云盘基础信息 |
| 文件分页 | POST | /papi/file/page | 文件分页 |
| 超出容量文件分页 | POST | /papi/file/overCapacityPage | 超出容量文件分页 |
| 预上传文件分片 | POST | /papi/file/upload/preUpload | 预上传文件分片 |
| 推送文件到云手机 | POST | /papi/file/uploadContainerFile | 推送文件到云手机 |
| 上传附件 | POST | /papi/file/uploadAttachment | 上传附件 |
| 上传文件至系统 | POST | /papi/file/upload/chunk | 上传文件至系统 |
操作日志
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 获得API访问日志分页 | POST | /papi/zw/log/api-access/page | 获得API访问日志分页 |
| 获得操作日志分页 | POST | /papi/zw/log/operate/page | 获得操作日志分页 |
支付订单
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 取消订单 | POST | /papi/order/cancel | 取消订单 |
| 云盘所有套餐list | POST | /papi/product/cloudDeviceAllPackageList | 获取所有云盘套餐 |
| 云盘套餐list | POST | /papi/product/cloudDevicePackageList | 获取云盘套餐列表 |
| 云盘SkuList | POST | /papi/product/cloudDeviceSkuList | 获取云盘SKU列表 |
| 云机所有套餐list | POST | /papi/product/containerAllPackageList | 获取所有云机套餐 |
| 云机套餐list | POST | /papi/product/containerPackageList | 获取云机套餐列表 |
| 云机SkuList | POST | /papi/product/containerSkuList | 获取云机SKU列表 |
| 确认订单是否支付 | POST | /papi/order/checkChannelPayStatus | 确认订单是否支付 |
| 云盘续费订单创建 | POST | /papi/order/cloudDisk/renewal/create | 云盘续费订单创建 |
| 获取订单详情 | POST | /papi/order/details | 获取订单详情 |
| 获取支付订单详情 | GET | /papi/order/getPayOrder | 获取支付订单详情 |
| 获得支付地区列表 | POST | /papi/pay/area/list | 获得支付地区列表 |
| 云机库存 | POST | /papi/product/containerStock | 查询云机库存 |
| 静态IP续费订单创建 | POST | /papi/order/ip/renewal/create | 创建静态IP续费订单 |
| 订单详情 | POST | /papi/order/getOrderDetail | 获取订单详情 |
| 支付订单分页 | POST | /papi/order/page | 支付订单分页 |
| 订单支付 | POST | /papi/order/orderPay | 订单支付 |
| 获取支付方式 | POST | /papi/pay/payWayList | 获取支付方式 |
| 商品下单 | POST | /papi/order/create | 商品下单 |
| 商品价格计算 | POST | /papi/product/price-calc | 商品价格计算 |
| 云机购买数据 | GET | /papi/product/containerBuyData | 获取云机购买数据 |
| 云机续费订单创建 | POST | /papi/order/renewal/create | 云机续费订单创建 |
| 云机续费价格计算 | POST | /papi/order/renewal/price-calc | 云机续费价格计算 |
| 获得sku适配应用列表 | GET | /papi/sku-adapt-app/list | 获得SKU适配应用列表 |
| 校验或重新生成支付方式 | POST | /papi/order/check-payment | 校验或重新生成支付方式 |
任务管理
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 获得容器操作任务分页 | POST | /papi/zw/task/page | 获得容器操作任务分页 |
| 根据主任务UUID列表获得主任务列表 | POST | /papi/zw/task/list | 根据主任务UUID列表获得主任务列表 |
| 根据子任务UUID列表获得子任务详情 | POST | /papi/zw/subtask/detailList | 根据子任务UUID列表获得子任务详情 |
| 根据主任务UUID列表获得子任务列表 | POST | /papi/zw/subtask/listByTaskId | 根据主任务UUID列表获得子任务列表 |
| 根据主任务UUID获得子任务列表 | POST | /papi/zw/subtask/list | 根据主任务UUID获得子任务列表 |
| 获得子任务分页 | POST | /papi/zw/subtask/page | 获得子任务分页 |
钱包管理
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 自动续费策略分页 | POST | /papi/wallet/auto-renew/page | 按资源类型分页查询自动续费策略 |
| 查询自动续费任务 | POST | /papi/wallet/auto-renew/task/page | 分页查询自动续费任务执行记录 |
| 设置自动续费开关 | POST | /papi/wallet/auto-renew/update | 开启或关闭资源自动续费 |
| 创建充值 | POST | /papi/wallet/recharge/create | 创建钱包充值单 |
| 查询余额 | POST | /papi/wallet/balance | 查询钱包余额及累计充值、扣款统计 |
| 查询充值状态 | POST | /papi/wallet/recharge/get | 按充值订单号查询到账状态 |
| 查询充值流水 | POST | /papi/wallet/recharge/page | 分页查询已到账的充值流水 |
| 查询资金流水 | POST | /papi/wallet/transaction/page | 分页查询全部资金流水 |
