# VMOSCloud OpenAPI 开发者速查手册

供 AI/大模型/代码助手直接读取。完整请求/响应参数与示例见 OpenAPI.md，认证签名见 example.md。

## 认证方式
HMAC-SHA256 签名验证（必需）

请求头（每个请求必需）：
- x-date: 请求UTC时间，ISO 8601格式（如 20240301T093700Z）
- x-host: 接口访问域名（api.vmoscloud.com）
- Content-Type: application/json
- authorization: HMAC-SHA256 签名

签名格式：
HMAC-SHA256 Credential={AccessKey}, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature={Signature}

签名计算步骤及示例见使用指南 example.md

## 基础信息
域名: https://api.vmoscloud.com
路径前缀: /vcpcloud/api/padApi/
响应格式: JSON {code, msg, ts, data}
成功状态码: code=200

## API接口清单

### 1. 实例管理
POST  /vcpcloud/api/padApi/setWifiList - 修改实例WIFI属性
  参数：padCodes[]，wifiJsonList[]，SSID，BSSID，MAC，IP，gateway，DNS1，DNS2，hessid，anqpDomainId，capabilities，level，linkSpeed，txLinkSpeed，rxLinkSpeed，frequency，distance，distanceSd，channelWidth
POST  /vcpcloud/api/padApi/padDetails - 实例详情(待上线)
POST  /vcpcloud/api/padApi/restart - 实例重启
  参数：padCodes[]
POST  /vcpcloud/api/padApi/reset - 实例重置
  参数：padCodes[]
POST  /vcpcloud/api/padApi/padProperties - 查询实例属性
  参数：padCode
POST  /vcpcloud/api/padApi/batchPadProperties - 批量查询实例属性
  参数：padCodes[]
POST  /vcpcloud/api/padApi/updatePadProperties - 修改实例属性(动态生效)
  参数：padCodes[]，modemPersistPropertiesList[]，propertiesName，propertiesValue，modemPropertiesList[]，systemPersistPropertiesList[]，systemPropertiesList[]，settingPropertiesList[]，oaidPropertiesList[]
POST  /vcpcloud/api/padApi/updatePadAndroidProp - 修改实例安卓改机属性(需重启)
  参数：padCode，restart，props，ro.product.vendor.name
POST  /vcpcloud/api/padApi/updateSIM - 根据国家Code修改SIM卡信息
  参数：padCode，countryCode，props，ro.product.vendor.name
POST  /vcpcloud/api/padApi/dissolveRoom - 停止推流
  参数：padCodes[]
POST  /vcpcloud/api/padApi/checkIP - 智能IP代理检测
  参数：host，port，account，password，type，country，ip，loc，city，region，timezone
POST  /vcpcloud/api/padApi/smartIp - 设置智能IP
  参数：padCodes[]，host，port，account，password，type，mode，bypassPackageList[]，bypassIpList[]，bypassDomainList[]
POST  /vcpcloud/api/padApi/notSmartIp - 取消智能IP
  参数：padCodes[]
POST  /vcpcloud/api/padApi/getTaskStatus - 设备任务执行结果查询(智能IP)
  参数：taskId
POST  /vcpcloud/api/padApi/getListInstalledApp - 获取指定云机安装的应用信息
  参数：padCodeList[]
POST  /vcpcloud/api/padApi/updateTimeZone - 修改实例时区
  参数：timeZone，padCodes[]
POST  /vcpcloud/api/padApi/updateLanguage - 修改实例语言
  参数：language，country，padCodes[]
POST  /vcpcloud/api/padApi/gpsInjectInfo - 设置实例经纬度
  参数：longitude，latitude，altitude，speed，bearing，horizontalAccuracyMeters，padCodes[]
POST  /vcpcloud/open/network/proxy/info - 查询实例代理信息(待上线)
  参数：padCodes[]，padCode
POST  /vcpcloud/api/padApi/replacePad - 一键新机
  参数：padCodes[]，countryCode，realPhoneTemplateId，androidProp，replacementRealAdiFlag，excludeRealPhoneTemplateIds[]，certificate，wipeData，wipeSpecificData[]，webviewId
GET  /vcpcloud/api/padApi/country - 查询一键新机支持国家列表
  参数：无
POST  /vcpcloud/api/padApi/webview/version/list - 查询可用WebView版本
  参数：无
POST  /vcpcloud/api/padApi/updateContacts - 更新通讯录
  参数：padCodes[]，fileUniqueId，operateType，info[]，firstName，phone，email
POST  /vcpcloud/api/padApi/setProxy - 实例设置代理
  参数：account，password，ip，port，enable，padCodes[]，proxyType，proxyName，model，bypassPackageList[]，bypassIpList[]，bypassDomainList[]，limitPackageList[]，limitIpList[]，limitDomainList[]，sUoT
POST  /vcpcloud/api/padApi/listInstalledApp - 实时查询已安装的应用列表
  参数：padCodes[]，appName
POST  /vcpcloud/api/padApi/setKeepAliveApp - 设置应用自启动
  参数：padCodes[]，applyAllInstances，appInfos[]，serverName
POST  /vcpcloud/api/padApi/setHideAppList - 设置应用隐藏(待上线)
  参数：padCodes[]，appInfos[]，packageName
POST  /vcpcloud/api/padApi/replaceRealAdiTemplate - 修改真机ADI模板
  参数：padCodes[]，wipeData，realPhoneTemplateId
POST  /vcpcloud/api/padApi/asyncCmd - 异步执行ADB命令
  参数：padCodes[]，scriptContent
POST  /vcpcloud/api/padApi/switchRoot - 开关Root权限
  参数：padCodes[]，globalRoot，packageName，rootStatus
POST  /vcpcloud/api/padApi/screenshot - 本地截图
  参数：padCodes[]，rotation，broadcast，definition，resolutionHeight，resolutionWidth
POST  /vcpcloud/api/padApi/getLongGenerateUrl - 获取实例实时预览图片
  参数：padCodes[]，format，height，width，quality
POST  /vcpcloud/api/padApi/upgradeImage - 升级镜像
  参数：padCodes[]，imageId，wipeData，enableCpuCoreConfig
POST  /vcpcloud/api/padApi/virtualRealSwitch - 升级真机镜像
  参数：padCodes[]，imageId，wipeData，realPhoneTemplateId，upgradeImageConvertType，screenLayoutId，certificate，deviceAndroidProps，enableCpuCoreConfig
POST  /vcpcloud/api/padApi/templateList - 分页获取真机模板
  参数：page，rows
POST  /vcpcloud/api/padApi/modelInfo - 批量获取实例机型信息(待上线)
  参数：padCodes[]
POST  /vcpcloud/api/padApi/setSpeed - 设置实例带宽(待上线)
  参数：padCodes[]，upBandwidth，downBandwidth
POST  /vcpcloud/api/padApi/openOnlineAdb - 开启关闭ADB
  参数：padCodes[]，openStatus
POST  /vcpcloud/api/padApi/adb - 获取ADB连接信息
  参数：padCode，enable，expireMinutes
POST  /vcpcloud/api/padApi/batch/adb - 批量获取ADB连接信息(待上线)
  参数：padCodes[]，enable
POST  /vcpcloud/api/padApi/simulateTouch - 模拟触控
  参数：padCodes[]，width，height，pointCount，positions[]
POST  /vcpcloud/api/padApi/padTaskDetail - 实例操作任务详情
  参数：taskIds[]，taskId
POST  /vcpcloud/api/padApi/executeScriptInfo - 获取实例执行脚本结果(待上线)
  参数：taskIds
POST  /vcpcloud/api/padApi/screenshotInfo - 获取实例截图结果(待上线)
  参数：taskIds
POST  /vcpcloud/api/padApi/padExecuteTaskInfo - 实例重启重置执行结果(待上线)
  参数：taskIds
POST  /vcpcloud/api/padApi/infos - 实例分组列表/实例列表信息
  参数：page，rows，padType，padCodes[]
POST  /vcpcloud/api/padApi/addPhoneRecord - 导入通话记录
  参数：padCodes[]，callRecords[]
POST  /vcpcloud/api/padApi/inputText - 云机文本信息输入
  参数：padCodes[]，text，code，msg，ts，data[]，padCode，taskId，vmStatus，taskStatus
POST  /vcpcloud/api/padApi/simulateSendSms - 模拟发送短信
  参数：padCodes[]，senderNumber，smsContent
POST  /vcpcloud/api/padApi/resetGAID - 重置GAID
  参数：padCodes[]，resetGmsType，oprBy，taskSource
POST  /vcpcloud/api/padApi/injectAudioToMic - 注入音频到实例麦克风
  参数：padCodes[]，url，fileUniqueId，enable
POST  /vcpcloud/api/padApi/cleanAppHome - 清除进程并返回桌面(待上线)
  参数：padCodes[]
POST  /vcpcloud/api/padApi/unmannedLive - 无人直播
  参数：padCodes[]，injectSwitch，injectLoop，injectUrl，injectUrls[]
POST  /vcpcloud/api/padApi/injectPicture - 图片注入(待上线)
  参数：padCodes[]，injectSwitch，injectLoop，injectUrl
POST  /vcpcloud/api/padApi/addUserRom - 上传用户镜像
  参数：name，updateLog，androidVersion，version，downloadUrl，packageSize
POST  /vcpcloud/api/padApi/replacement - 换机
  参数：padCode
POST  /vcpcloud/api/padApi/confirmTransfer - 云机转移
  参数：padCodes[]，makeOverMobilePhone
POST  /vcpcloud/api/padApi/setHideAccessibilityAppList - 隐藏辅助服务
  参数：padCodes[]，appInfos[]，packageName

### 2. 资源管理
POST  /vcpcloud/api/padApi/infos - 实例列表信息(分页查询已订购实例)
  参数：page，rows，padType，padCodes[]

### 3. 应用管理
POST  /vcpcloud/api/padApi/uninstallApp - 应用卸载
  参数：apkPackageList[]，padCodeList[]
POST  /vcpcloud/api/padApi/startApp - 应用启动
  参数：pkgName，padCodes[]
POST  /vcpcloud/api/padApi/stopApp - 应用停止
  参数：pkgName，padCodes[]
POST  /vcpcloud/api/padApi/restartApp - 应用重启
  参数：pkgName，padCodes[]
POST  /vcpcloud/api/padApi/listInstalledApp - 实例安装应用列表查询
  参数：padCodes[]，appName
POST  /vcpcloud/api/padApi/uploadFileV3 - 文件通过链接直接上传
  参数：padCodes[]，padCode，autoInstall，fileUniqueId，customizeFilePath，fileName，packageName，url，md5，isAuthorization，iconPath
POST  /vcpcloud/api/padApi/uploadFile - 上传文件到云空间
  参数：file
POST  /vcpcloud/api/padApi/deleteOssFiles - 删除云空间文件
  参数：files[]，urls[]
POST  /vcpcloud/api/padApi/selectFiles - 查询用户的文件列表
  参数：无

### 4. 任务管理
POST  /vcpcloud/api/padApi/padTaskDetail - 实例操作任务详情
  参数：taskIds[]，taskId
POST  /vcpcloud/api/padApi/fileTaskDetail - 文件任务详情
  参数：taskIds[]，taskId

### 5. 云手机管理
POST  /vcpcloud/api/padApi/createMoneyOrder - 新建续费云手机
  参数：androidVersionName，goodId，goodNum，autoRenew，equipmentId，countryCode
POST  /vcpcloud/api/padApi/userPadList - 云手机列表
  参数：padCode，equipmentIds[]
POST  /vcpcloud/api/padApi/padInfo - 云手机信息查询
  参数：padCode
GET  /vcpcloud/api/padApi/getCloudGoodList - sku套餐列表
  参数：androidVersion，goodIds
POST  /vcpcloud/api/padApi/createMoneyProOrder - 设备预售购买
  参数：androidVersionName，goodId，goodNum，autoRenew
POST  /vcpcloud/api/padApi/queryProOrderList - 查询预售订单结果详情
  参数：proBuyStatus，orderId
POST  /vcpcloud/api/padApi/imageVersionList - 安卓镜像版本集合
  参数：padCode
POST  /vcpcloud/api/padApi/createByTimingOrder - 创建计时设备订单
  参数：goodId，goodNum
POST  /vcpcloud/api/padApi/timingPadOn - 计时设备开机
  参数：padCodes[]，defCode，netStorageResUnitCode
POST  /vcpcloud/api/padApi/timingPadOff - 计时设备关机
  参数：padCodes[]，isBackUp，remark
POST  /vcpcloud/api/padApi/timingPadDel - 计时设备销毁
  参数：padCodes[]
GET  /vcpcloud/api/padApi/vcTimingBackupList - 存储资源包列表
  参数：无
GET  /vcpcloud/api/padApi/getRenewStorageInfo - 云空间存储剩余容量
  参数：无
GET  /vcpcloud/api/padApi/getVcStorageGoods - 云空间商品列表
  参数：无
POST  /vcpcloud/api/padApi/buyStorageGoods - 购买云空间扩容
  参数：storageId，autoRenewOrder
GET  /vcpcloud/api/padApi/selectAutoRenew - 云空间续费详情查询
  参数：无
POST  /vcpcloud/api/padApi/renewsStorageGoods - 聚合续费云空间商品
  参数：autoRenewOrder
GET  /vcpcloud/api/padApi/updateRenewStorageStatus - 云空间自动续费开关
  参数：renewStorageStatus
POST  /vcpcloud/api/padApi/deleteUploadFiles - 删除备份资源包数据
  参数：backupIds[]
POST  /vcpcloud/api/padApi/toggleProcessHide - 显示或隐藏应用进程
  参数：padCodes[]，show，packageName

### 6. 邮箱接码服务
GET  /vcpcloud/api/padApi/getEmailServiceList - 获取邮箱服务列表
  参数：无
GET  /vcpcloud/api/padApi/getEmailTypeList - 获取邮箱类型及剩余库存
  参数：serviceId
POST  /vcpcloud/api/padApi/createEmailOrder - 创建购买邮箱订单
  参数：serviceId，emailTypeId，goodNum
GET  /vcpcloud/api/padApi/getEmailOrder - 查询购买的邮箱列表
  参数：page，size，serviceId，email，status
GET  /vcpcloud/api/padApi/getEmailCode - 刷新获取邮箱验证码
  参数：orderId

### 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 - 购买动态代理流量包
  参数：goodId，goodNum，autoRenewOrder
POST  /vcpcloud/api/padApi/createProxy - 创建动态代理
  参数：city，countryCode，goodNum，proxyHost，proxyType，proxyUseType，state，time
GET  /vcpcloud/api/padApi/getProxys - 查询动态代理列表
  参数：page，rows
POST  /vcpcloud/api/padApi/getDynamicProxyOrders - 查询动态代理订单列表
  参数：page，rows，completeStartTime，completeEndTime
POST  /vcpcloud/api/padApi/batchPadConfigProxy - 云机配置动态代理
  参数：padCodes[]，setProxyFlag，proxyIds[]
POST  /vcpcloud/api/padApi/selectBatchPadProxyTask - 查询批量云机设置代理任务
  参数：taskId
GET  /vcpcloud/api/padApi/getDynamicProxyAutomaticRenewal - 查询动态代理自动续费信息
  参数：无
POST  /vcpcloud/api/padApi/setAutoRenewSwitch - 设置动态代理自动续费开关
  参数：autoRenewOrder
POST  /vcpcloud/api/padApi/delProxyByIds - 删除动态代理
  参数：ids[]

### 8. 静态住宅代理服务
GET  /vcpcloud/api/padApi/proxyGoodList - 获取静态住宅商品列表
  参数：无
GET  /vcpcloud/api/padApi/getProxyRegion - 获取静态住宅支持的国家城市
  参数：无
POST  /vcpcloud/api/padApi/createProxyOrder - 静态住宅商品购买
  参数：proxyGoodId，region，num，country，proxyAddress，autoRenew
POST  /vcpcloud/api/padApi/selectProxyOrderList - 静态住宅代理订单明细
  参数：page，rows
POST  /vcpcloud/api/padApi/createRenewProxyOrder - 静态住宅代理续费
  参数：proxyGoodId，proxyIps，autoRenew
POST  /vcpcloud/api/padApi/queryProxyList - 查询静态住宅代理列表
  参数：current，size

### 9. TK自动化
POST  /vcpcloud/api/padApi/autoTaskList - 自动化任务列表查询
  参数：taskIds[]，taskType，page，rows
POST  /vcpcloud/api/padApi/addAutoTask - 创建自动化任务
  参数：taskName，remarks，taskType，list[]
POST  /vcpcloud/api/padApi/reExecutionAutoTask - 自动化任务重试
  参数：taskIds[]，plannedExecutionTime
POST  /vcpcloud/api/padApi/cancelAutoTask - 自动化任务取消
  参数：taskIds[]

### 10. SDK Token
POST  /vcpcloud/api/padApi/stsTokenByPadCode - 根据padCode获取SDK临时token
  参数：padCode
GET  /vcpcloud/api/padApi/getSessionToken - 获取群控token
  参数：deviceKey，expireSeconds
POST  /vcpcloud/api/padApi/clearStsToken - 清除SDK授权Token
  参数：token

## 回调通知事件

999 - 实例状态回调
1000 - 实例重启任务
1001 - 实例重置任务
1002 - 异步执行ADB任务
1003 - 应用安装任务
1004 - 应用卸载任务
1005 - 应用停止任务
1006 - 应用重启任务
1007 - 应用启动任务
1009 - 实例文件上传任务
1012 - 实例升级镜像任务
1124 - 一键新机
4001 - 用户镜像上传

详细字段与示例见 callback.md

## 常见错误码

200 - 成功
2031 - 无效的密钥
2032 - 请求头缺少Authorization
2019 - 验证签名失败
100000 - 请求参数不正确
100003 - 缺少请求头Authorization
100004 - 无效的签名
100005 - 验证签名失败
110028 - 实例不存在
110013 - 实例不存在
110031 - 实例未就绪
120008 - token不属于当前用户

更多错误码见 ErrorCode.md

## 使用建议

1. 认证安全
   - 妥善保管AK/SK，勿在客户端硬编码
   - 定期更换密钥

2. 异步任务
   - 重启、重置、安装、上传等为异步任务
   - 建议配置回调或使用任务详情接口轮询结果

3. 批量限制
   - 批量接口有数量上限（如200个实例）
   - 注意分批与失败列表处理

4. 实例状态
   - 部分操作要求实例在线或就绪
   - 先查实例状态再调用

5. 改机与重启
   - 修改安卓改机属性、SIM等需重启生效
   - 与「修改实例属性」的生效时机区别

## 相关文档
- 完整接口文档: OpenAPI.md
- 认证与签名: example.md
- 错误码说明: ErrorCode.md
- 回调类型与示例: callback.md
- 实例列表字段: InstanceList.md
- 安卓改机属性: InstanceAndroidPropList.md

---
文档版本: 速查版
内容以 OpenAPI.md 为准