VMOSCloud OpenAPI 开发者速查手册
VMOSCloud 云手机服务 OpenAPI 接口快速参考 · 适合 AI 工具直接读取
本文档为 AI 快速参考：供大模型、代码助手等工具快速解析接口路径、方法及用途。详细请求/响应参数、示例以 接口文档 为准。
📥 下载纯文本版本 — 适合 AI 工具直接读取
获取方式：
- 浏览器下载：点击此处下载 llms-ai-reference.txt，或访问
https://api.vmoscloud.com/vmoscloud/doc/zh/server/llms-ai-reference.txt - 命令行获取：
curl https://api.vmoscloud.com/vmoscloud/doc/zh/server/llms-ai-reference.txt -o vmoscloud-api.txt - 在线预览：浏览器中打开上述链接可查看原始文本（如遇乱码请设置编码为 UTF-8）
🔐 认证方式（必读）
认证说明
本 API 使用 HMAC-SHA256 签名验证。
请求头设置（每个请求必需）
| 请求头 | 说明 | 示例值 |
|---|---|---|
| x-date | 请求 UTC 时间，ISO 8601 格式 | 20240301T093700Z |
| x-host | 接口访问域名 | api.vmoscloud.com |
| Content-Type | 资源 MIME 类型 | application/json |
| authorization | HMAC-SHA256 签名 | 见 使用指南 |
Authorization 格式
HMAC-SHA256 Credential={AccessKey}, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature={Signature}
签名计算步骤（规范请求、待签名字符串、SigningKey、Signature）及示例代码请参考 使用指南 - Authorization 签名机制。
📡 基础信息
| 配置项 | 值 |
|---|---|
| 接口域名 | https://api.vmoscloud.com |
| 路径前缀 | /vcpcloud/api/padApi/（多数接口） |
| 响应格式 | JSON { code, msg, ts, data } |
| 成功状态码 | code=200 |
📚 API 功能分类
1️⃣ 实例管理
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 修改实例 WIFI 属性 | POST | /vcpcloud/api/padApi/setWifiList | 修改指定实例的 WIFI 列表属性 |
| 实例详情 | POST | /vcpcloud/api/padApi/padDetails | 查询指定实例属性（待上线） |
| 实例重启 | POST | /vcpcloud/api/padApi/restart | 对指定实例执行重启 |
| 实例重置 | POST | /vcpcloud/api/padApi/reset | 清理云机所有数据 |
| 查询实例属性 | POST | /vcpcloud/api/padApi/padProperties | 查询实例系统/设置属性 |
| 批量查询实例属性 | POST | /vcpcloud/api/padApi/batchPadProperties | 批量查询实例属性 |
| 修改实例属性 | POST | /vcpcloud/api/padApi/updatePadProperties | 动态修改实例属性 |
| 修改实例安卓改机属性 | POST | /vcpcloud/api/padApi/updatePadAndroidProp | 静态改机属性，需重启生效 |
| 根据国家 Code 修改 SIM 卡信息 | POST | /vcpcloud/api/padApi/updateSIM | 按国家随机生成 SIM 并重启 |
| 停止推流 | POST | /vcpcloud/api/padApi/dissolveRoom | 停止指定实例推流 |
| 智能 IP 代理检测 | POST | /vcpcloud/api/padApi/checkIP | 检测代理 IP 与归属地 |
| 设置智能 IP | POST | /vcpcloud/api/padApi/smartIp | 设置智能 IP（出口 IP、SIM、GPS 等） |
| 取消智能 IP | POST | /vcpcloud/api/padApi/notSmartIp | 取消智能 IP |
| 设备任务执行结果查询 | POST | /vcpcloud/api/padApi/getTaskStatus | 查询智能 IP 任务结果 |
| 获取指定云机安装的应用信息 | POST | /vcpcloud/api/padApi/getListInstalledApp | 批量获取安装的应用信息 |
| 修改实例时区 | POST | /vcpcloud/api/padApi/updateTimeZone | 修改实例时区 |
| 修改实例语言 | POST | /vcpcloud/api/padApi/updateLanguage | 修改实例语言 |
| 设置实例经纬度 | POST | /vcpcloud/api/padApi/gpsInjectInfo | 设置实例 GPS |
| 查询实例代理信息 | POST | /vcpcloud/open/network/proxy/info | 查询实例代理信息（待上线） |
| 一键新机 | POST | /vcpcloud/api/padApi/replacePad | 清空数据并重新设置安卓属性 |
| 查询一键新机支持国家列表 | GET | /vcpcloud/api/padApi/country | 一键新机支持国家 |
| 更新通讯录 | POST | /vcpcloud/api/padApi/updateContacts | 更新通讯录 |
| 实例设置代理 | POST | /vcpcloud/api/padApi/setProxy | 对指定实例设置代理 |
| 实时查询已安装的应用列表 | POST | /vcpcloud/api/padApi/listInstalledApp | 实时查询已安装应用 |
| 设置应用自启动 | POST | /vcpcloud/api/padApi/setKeepAliveApp | 设置应用自启动（安卓 13/14/15） |
| 设置应用隐藏 | POST | /vcpcloud/api/padApi/setHideAppList | 下发隐藏包名列表（待上线） |
| 修改真机 ADI 模板 | POST | /vcpcloud/api/padApi/replaceRealAdiTemplate | 修改云真机 ADI 模板 |
| 异步执行 ADB 命令 | POST | /vcpcloud/api/padApi/asyncCmd | 异步执行命令 |
| 开关 Root 权限 | POST | /vcpcloud/api/padApi/switchRoot | 开关 root 权限 |
| 本地截图 | POST | /vcpcloud/api/padApi/screenshot | 实例截图 |
| 获取实例实时预览图片 | POST | /vcpcloud/api/padApi/getLongGenerateUrl | 获取实时预览图 URL |
| 升级镜像 | POST | /vcpcloud/api/padApi/upgradeImage | 批量实例镜像升级 |
| 升级真机镜像 | POST | /vcpcloud/api/padApi/virtualRealSwitch | 批量真机镜像升级 |
| 分页获取真机模板 | POST | /vcpcloud/api/padApi/templateList | 分页获取真机模板 |
| 批量获取实例机型信息 | POST | /vcpcloud/api/padApi/modelInfo | 批量获取机型信息（待上线） |
| 设置实例带宽 | POST | /vcpcloud/api/padApi/setSpeed | 设置实例带宽（待上线） |
| 开启/关闭 ADB | POST | /vcpcloud/api/padApi/openOnlineAdb | 打开或关闭实例 ADB |
| 获取 ADB 连接信息 | POST | /vcpcloud/api/padApi/adb | 获取 adb 连接信息 |
| 批量获取 ADB 连接信息 | POST | /vcpcloud/api/padApi/batch/adb | 批量获取/关闭 adb（待上线） |
| 模拟触控 | POST | /vcpcloud/api/padApi/simulateTouch | 模拟触控事件 |
| 实例操作任务详情 | POST | /vcpcloud/api/padApi/padTaskDetail | 查询实例操作任务结果 |
| 获取实例执行脚本结果 | POST | /vcpcloud/api/padApi/executeScriptInfo | 获取脚本执行结果（待上线） |
| 获取实例截图结果 | POST | /vcpcloud/api/padApi/screenshotInfo | 通过任务 ID 获取截图结果（待上线） |
| 实例重启/重置执行结果 | POST | /vcpcloud/api/padApi/padExecuteTaskInfo | 重启/重置任务结果（待上线） |
| 实例分组列表 | POST | /vcpcloud/api/padApi/infos | 实例分组列表（infos 亦用于实例列表信息） |
| 导入通话记录 | POST | /vcpcloud/api/padApi/addPhoneRecord | 导入通话记录 |
| 云机文本信息输入 | POST | /vcpcloud/api/padApi/inputText | 在聚焦输入框内输入文本 |
| 模拟发送短信 | POST | /vcpcloud/api/padApi/simulateSendSms | 向实例模拟下发短信 |
| 重置 GAID | POST | /vcpcloud/api/padApi/resetGAID | 重置 advertising ID |
| 注入音频到实例麦克风 | POST | /vcpcloud/api/padApi/injectAudioToMic | 注入音频到麦克风 |
| 创建本地实例备份 | POST | /vcpcloud/api/padApi/localPodBackup | 创建本地备份（待上线） |
| 创建本地实例还原 | POST | /vcpcloud/api/padApi/localPodRestore | 本地备份还原（待上线） |
| 本地实例备份结果查询 | POST | /vcpcloud/api/padApi/localPodBackupSelectPage | 查询本地可用备份（待上线） |
| 清除进程并返回桌面 | POST | /vcpcloud/api/padApi/cleanAppHome | 清除进程并返回桌面（待上线） |
| 无人直播 | POST | /vcpcloud/api/padApi/unmannedLive | 实例注入视频 |
| 图片注入 | POST | /vcpcloud/api/padApi/injectPicture | 实例注入图片（待上线） |
| 上传用户镜像 | POST | /vcpcloud/api/padApi/addUserRom | 上传用户镜像 |
| 换机 | POST | /vcpcloud/api/padApi/replacement | 换机 |
| 云机转移 | POST | /vcpcloud/api/padApi/confirmTransfer | 云机转移至另一账户 |
| 隐藏辅助服务 | POST | /vcpcloud/api/padApi/setHideAccessibilityAppList | 隐藏辅助服务 |
2️⃣ 资源管理
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 实例列表信息 | POST | /vcpcloud/api/padApi/infos | 分页查询已订购实例列表 |
3️⃣ 应用管理
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 应用安装 | POST | /vcpcloud/api/padApi/installApp | 为单台或多台实例同时安装单个或多个APP（异步），支持黑白名单 |
| 应用卸载 | POST | /vcpcloud/api/padApi/uninstallApp | 按实例与包名批量卸载 |
| 应用启动 | POST | /vcpcloud/api/padApi/startApp | 按实例与包名启动应用 |
| 应用停止 | POST | /vcpcloud/api/padApi/stopApp | 停止应用 |
| 应用重启 | POST | /vcpcloud/api/padApi/restartApp | 重启应用 |
| 实例安装应用列表查询 | POST | /vcpcloud/api/padApi/listInstalledApp | 查询实例已安装应用 |
| 文件通过链接直接上传 | POST | /vcpcloud/api/padApi/uploadFileV3 | 通过 URL 上传并可选安装 |
| 上传文件到云空间 | POST | /vcpcloud/api/padApi/uploadFile | 上传文件到云空间 |
| 删除云空间文件 | POST | /vcpcloud/api/padApi/deleteOssFiles | 删除云空间文件 |
| 查询用户的文件列表 | POST | /vcpcloud/api/padApi/selectFiles | 查询用户文件列表 |
4️⃣ 任务管理
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 实例操作任务详情 | POST | /vcpcloud/api/padApi/padTaskDetail | 查询实例操作任务执行结果 |
| 文件任务详情 | POST | /vcpcloud/api/padApi/fileTaskDetail | 查询文件任务执行结果 |
5️⃣ 云手机管理
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 新建/续费云手机 | POST | /vcpcloud/api/padApi/createMoneyOrder | 新建或续费云手机 |
| 云手机列表 | POST | /vcpcloud/api/padApi/userPadList | 云手机列表 |
| 云手机信息查询 | POST | /vcpcloud/api/padApi/padInfo | 云手机信息查询 |
| sku 套餐列表 | GET | /vcpcloud/api/padApi/getCloudGoodList | sku 套餐列表 |
| 设备预售购买 | POST | /vcpcloud/api/padApi/createMoneyProOrder | 设备预售购买 |
| 查询预售订单结果详情 | POST | /vcpcloud/api/padApi/queryProOrderList | 预售订单详情 |
| 安卓镜像版本集合 | POST | /vcpcloud/api/padApi/imageVersionList | 可升级镜像集合 |
| 创建计时设备订单 | POST | /vcpcloud/api/padApi/createByTimingOrder | 创建计时设备订单 |
| 计时设备开机 | POST | /vcpcloud/api/padApi/timingPadOn | 计时设备开机 |
| 计时设备关机 | POST | /vcpcloud/api/padApi/timingPadOff | 计时设备关机 |
| 计时设备销毁 | POST | /vcpcloud/api/padApi/timingPadDel | 计时设备销毁 |
| 存储资源包列表 | GET | /vcpcloud/api/padApi/vcTimingBackupList | 存储资源包列表 |
| 云空间存储剩余容量 | GET | /vcpcloud/api/padApi/getRenewStorageInfo | 云空间剩余容量 |
| 云空间商品列表 | GET | /vcpcloud/api/padApi/getVcStorageGoods | 云空间商品列表 |
| 购买云空间扩容 | POST | /vcpcloud/api/padApi/buyStorageGoods | 购买云空间扩容 |
| 云空间续费详情查询 | GET | /vcpcloud/api/padApi/selectAutoRenew | 云空间续费详情 |
| 聚合续费云空间商品 | POST | /vcpcloud/api/padApi/renewsStorageGoods | 聚合续费云空间商品 |
| 云空间自动续费开关 | GET | /vcpcloud/api/padApi/updateRenewStorageStatus | 云空间自动续费开关 |
| 删除备份资源包数据 | POST | /vcpcloud/api/padApi/deleteUploadFiles | 删除备份资源包 |
| 显示或隐藏应用进程 | POST | /vcpcloud/api/padApi/toggleProcessHide | 显示或隐藏应用进程 |
6️⃣ 邮箱接码服务
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 获取邮箱服务列表 | GET | /vcpcloud/api/padApi/getEmailServiceList | 邮箱服务列表 |
| 获取邮箱类型及剩余库存 | GET | /vcpcloud/api/padApi/getEmailTypeList | 邮箱类型与库存 |
| 创建购买邮箱订单 | POST | /vcpcloud/api/padApi/createEmailOrder | 创建邮箱订单 |
| 查询购买的邮箱列表 | GET | /vcpcloud/api/padApi/getEmailOrder | 购买的邮箱列表 |
| 刷新获取邮箱验证码 | GET | /vcpcloud/api/padApi/getEmailCode | 刷新获取验证码 |
7️⃣ 动态代理服务
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 查询动态代理商品列表 | GET | /vcpcloud/api/padApi/getDynamicGoodService | 动态代理商品列表 |
| 查询动态代理地区列表 | GET | /vcpcloud/api/padApi/getDynamicProxyRegion | 动态代理地区列表 |
| 获取动态代理当前余量 | GET | /vcpcloud/api/padApi/queryCurrentTrafficBalance | 当前流量余量 |
| 查询支持的服务器地区 | GET | /vcpcloud/api/padApi/getDynamicProxyHost | 支持的服务器地区 |
| 购买动态代理流量包 | POST | /vcpcloud/api/padApi/buyDynamicProxy | 购买动态代理流量包 |
| 创建动态代理 | POST | /vcpcloud/api/padApi/createProxy | 创建动态代理 |
| 查询动态代理列表（分页） | GET | /vcpcloud/api/padApi/getProxys | 动态代理列表 |
| 查询动态代理订单列表（分页） | POST | /vcpcloud/api/padApi/getDynamicProxyOrders | 动态代理订单列表 |
| 云机配置动态代理 | POST | /vcpcloud/api/padApi/batchPadConfigProxy | 云机配置动态代理 |
| 查询批量云机设置代理任务 | POST | /vcpcloud/api/padApi/selectBatchPadProxyTask | 批量设置代理任务结果 |
| 查询动态代理自动续费信息 | GET | /vcpcloud/api/padApi/getDynamicProxyAutomaticRenewal | 自动续费信息 |
| 设置动态代理自动续费开关 | POST | /vcpcloud/api/padApi/setAutoRenewSwitch | 自动续费开关 |
| 删除动态代理 | POST | /vcpcloud/api/padApi/delProxyByIds | 删除动态代理 |
8️⃣ 静态住宅代理服务
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 获取静态住宅商品列表 | GET | /vcpcloud/api/padApi/proxyGoodList | 静态住宅商品列表 |
| 获取静态住宅支持的国家城市 | GET | /vcpcloud/api/padApi/getProxyRegion | 国家城市信息 |
| 静态住宅商品购买 | POST | /vcpcloud/api/padApi/createProxyOrder | 静态住宅购买 |
| 静态住宅代理订单明细 | POST | /vcpcloud/api/padApi/selectProxyOrderList | 订单明细 |
| 静态住宅代理续费 | POST | /vcpcloud/api/padApi/createRenewProxyOrder | 静态住宅续费 |
| 查询静态住宅代理列表 | POST | /vcpcloud/api/padApi/queryProxyList | 静态住宅代理列表 |
9️⃣ TK 自动化
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 自动化任务列表查询 | POST | /vcpcloud/api/padApi/autoTaskList | 自动化任务列表 |
| 创建自动化任务 | POST | /vcpcloud/api/padApi/addAutoTask | 创建自动化任务 |
| 自动化任务重试 | POST | /vcpcloud/api/padApi/reExecutionAutoTask | 自动化任务重试 |
| 自动化任务取消 | POST | /vcpcloud/api/padApi/cancelAutoTask | 自动化任务取消 |
🔟 SDK Token
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 根据 padCode 获取 SDK 临时 token | POST | /vcpcloud/api/padApi/stsTokenByPadCode | 签发 SDK 临时 token |
| 清除 SDK 授权 Token | POST | /vcpcloud/api/padApi/clearStsToken | 清除 SDK 授权 Token |
📋 回调通知事件
| 事件 | taskBusinessType | 说明 |
|---|---|---|
| 实例状态回调 | 999 | 实例运行/连接状态变更 |
| 实例重启任务 | 1000 | 重启结果通知 |
| 实例重置任务 | 1001 | 重置结果通知 |
| 异步执行 ADB 任务 | 1002 | ADB 命令执行结果 |
| 应用安装任务 | 1003 | 应用安装结果 |
| 应用卸载任务 | 1004 | 应用卸载结果 |
| 应用停止任务 | 1005 | 应用停止结果 |
| 应用重启任务 | 1006 | 应用重启结果 |
| 应用启动任务 | 1007 | 应用启动结果 |
| 实例文件上传任务 | 1009 | 文件上传结果 |
| 实例升级镜像任务 | 1012 | 升级镜像结果 |
| 一键新机 | 1124 | 一键新机结果 |
| 用户镜像上传 | 4001 | 用户镜像上传结果 |
回调需在 WEB 端配置回调地址，详细字段与示例见 回调任务业务类型码。
🚦 常见错误码
| 错误码 | 说明 | 处理建议 |
|---|---|---|
| 200 | 成功 | - |
| 2031 | 无效的密钥 | 检查 AK/SK |
| 2032 | 请求头缺少 Authorization | 补充签名请求头 |
| 2019 | 验证签名失败 | 按 使用指南 核对签名 |
| 100000 | 请求参数不正确 | 检查参数是否符合要求 |
| 100003 | 缺少请求头 Authorization | 检查请求头 |
| 100004 | 无效的签名 | 检查签名计算 |
| 100005 | 验证签名失败 | 确认签名方式正确 |
| 110028 | 实例不存在 | 检查实例编号 |
| 110013 | 实例不存在 | 检查实例参数 |
| 110031 | 实例未就绪 | 等待实例就绪 |
| 120008 | token 不属于当前用户 | 确认 token 归属 |
更多错误码见 错误码说明。
💡 使用建议
提示
- 认证安全：妥善保管 AK/SK，勿在客户端硬编码，定期更换。
- 异步任务：重启、重置、安装、上传等为异步任务，建议配置回调或使用任务详情接口轮询结果。
- 批量限制：批量接口有数量上限（如 200 个实例），注意分批与失败列表处理。
- 实例状态：部分操作要求实例在线或就绪，请先查实例状态再调用。
- 改机与重启：修改安卓改机属性、SIM 等需重启生效，注意与「修改实例属性」的生效时机区别。
📖 相关文档
相关信息
| 文档 | 说明 |
|---|---|
| 接口文档 | 完整接口说明、请求/响应参数及示例 |
| 使用指南 | 认证、签名与调用示例 |
| 错误码说明 | 系统错误码与解决方案 |
| 回调任务业务类型码 | 回调类型与示例 JSON |
| 实例列表 | 实例列表字段说明 |
| 安卓改机属性列表 | 改机属性参考 |
文档版本：速查版
内容以 OpenAPI 接口文档 为准