自动化接口参考
最近更新:2026/11/13
北向自动化接口的基础地址是 https://app.yunyoo.ai/api,下文的路径都接在它后面。请求带 Authorization: Bearer <机器 token>,机器 token 的签发与作用域见自动化概览。
平台对这些接口校验请求签名,官方命令行会自动签名。自己编写的程序请改用 MCP 远程形态,或经命令行工具调用;签名方式目前不对外提供。
返回体统一为 {"code": 0, "data": …, "msg": "…"},code 为 0 表示成功,其它值见错误码。限流时返回 HTTP 429、错误码 53009 与 Retry-After 响应头。平台开启强制确认时,高风险的动作会先挂起并返回 53010,data.confirmation 给出确认单;用户批准后,带请求头 X-Yunyoo-Confirmation: <确认单编号> 重发同一请求。请求头 X-Yunyoo-Intent 可以写明这次操作的意图,确认页会显示给用户;带上 traceparent 时,同一追踪编号会记进运行报告。
会话
列出设备
GET /cloudphone/automation/envs
列出凭据范围内的设备:环境 ID、名称与状态。
权限:env.view(查看环境)。
返回的 data:EnvSummary[]。
列出节点
GET /cloudphone/automation/nodes
列出凭据可见的节点摘要。
作用域:observe。权限:env.view(查看环境)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
providerId | 查询 | integer | 否 | 只看这个节点 |
返回的 data:NodeSummary[]。
校验凭据
GET /cloudphone/automation/whoami
返回凭据所属的用户、作用域、设备范围与这个凭据可用的 MCP 工具。
返回的 data:WhoAmIResp
观测
证明状态
GET /cloudphone/automation/envs/{id}/attestation
只读查询设备的证明状态。
作用域:observe。权限:env.view(查看环境)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
返回的 data:{attestation: AttestationView}。
截图
GET /cloudphone/automation/envs/{id}/screenshot
截取设备屏幕。带 max_edge、format、quality、annotate 任一参数时返回压缩后的图像与原始分辨率、缩放比例(缺省 JPEG、长边 1024);都不带时返回旧版的原始截图。
作用域:observe。权限:env.remote.screenshot(截图)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
max_edge | 查询 | integer | 否 | 长边像素,256–2048,缺省 1024 |
format | 查询 | string | 否 | jpeg(缺省)或 png |
quality | 查询 | integer | 否 | JPEG 质量,1–100,缺省 75 |
annotate | 查询 | boolean | 否 | 为 true 时在图上标出最近一次读取界面的元素编号 |
返回的 data:ScreenshotView
自动化状态
GET /cloudphone/automation/envs/{id}/status
查询设备是否可交互、能力位与控制状态;动作前或动作失败时调用,按能力位判断可用的动作。
作用域:observe。权限:env.view(查看环境)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
返回的 data:StatusView
读取界面
GET /cloudphone/automation/envs/{id}/ui-tree
读取设备当前界面。带 format、scope、under、depth、max 任一参数时返回紧凑快照(缺省)或结构化树;都不带时返回旧版的原始界面树,新接入请带 format。
作用域:observe。权限:env.remote.screenshot(截图)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
includeInvisible | 查询 | boolean | 否 | 为 true 时包含不可见的元素 |
format | 查询 | string | 否 | compact(缺省,紧凑快照)或 json(结构化树) |
scope | 查询 | string | 否 | interactive(缺省,只列可交互或带文字的元素)或 all(全部元素) |
under | 查询 | string | 否 | 只看这个元素编号下的子树 |
depth | 查询 | integer | 否 | 子树深度上限,1–100 |
max | 查询 | integer | 否 | 最多列出的元素行数,1–2000,缺省 150 |
返回的 data:UITreeView
查找元素
POST /cloudphone/automation/envs/{id}/ui/find
按文字、正则、资源 ID、描述或类名在当前界面查找元素,条件之间取「且」;返回命中元素的紧凑行与在当前界面唯一的选择器建议,没有命中时返回空结果。
作用域:observe。权限:env.remote.screenshot(截图)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | UIFindInput | 是 | 查找条件 |
返回的 data:UIFindView
界面动作
清空输入框
POST /cloudphone/automation/envs/{id}/ui/clear
清空焦点输入框或 selector 指定的输入框。
作用域:ui-action。权限:env.remote.control(远程操控)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | UIActionInput | 是 | 动作参数 |
返回的 data:UIActionResult
输入法动作
POST /cloudphone/automation/envs/{id}/ui/editor
对焦点输入框执行输入法动作 editorAction(Android 的 IME 动作编号,如 2 前往、3 搜索、4 发送、6 完成)
作用域:ui-action。权限:env.remote.control(远程操控)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | UIActionInput | 是 | 动作参数 |
返回的 data:UIActionResult
按键
POST /cloudphone/automation/envs/{id}/ui/key
发送 Android 按键码 code(66 回车、4 返回、3 回到桌面、67 删除)
作用域:ui-action。权限:env.remote.control(远程操控)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | UIActionInput | 是 | 动作参数 |
返回的 data:UIActionResult
滑动
POST /cloudphone/automation/envs/{id}/ui/swipe
从 from 滑到 to(归一化坐标 0..1),durationMs 为滑动时长;用于翻页、滚动列表或下拉刷新。
作用域:ui-action。权限:env.remote.control(远程操控)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | UIActionInput | 是 | 动作参数 |
返回的 data:UIActionResult
点按
POST /cloudphone/automation/envs/{id}/ui/tap
点按元素;优先用元素编号(带上快照版本)、资源 ID、文字或描述定位,没有可用元素时才用归一化坐标 point;longPressMs 大于 0 时长按;平台判定为高风险的点按可能先挂起并返回确认单。
作用域:ui-action。权限:env.remote.control(远程操控)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | UIActionInput | 是 | 动作参数 |
返回的 data:UIActionResult
输入文本
POST /cloudphone/automation/envs/{id}/ui/type
向焦点输入框(或 selector 指定的元素)输入 text;clear 为 true 时先清空,submit 为 true 时输入后发送回车;能力位不含 textInput 时只能输入 ASCII。
作用域:ui-action。权限:env.remote.control(远程操控)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | UIActionInput | 是 | 动作参数 |
返回的 data:UIActionResult
等待条件
POST /cloudphone/automation/envs/{id}/ui/wait
等待一个条件成立:selector 指定的元素出现,或 until 为 gone(元素消失)、idle(界面保持 idleMs 毫秒不变)、animation(动画结束)、package(应用到前台);一次只等一种条件,timeoutMs 为等待上限,超时返回 1003。
作用域:ui-action。权限:env.remote.control(远程操控)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | UIActionInput | 是 | 动作参数 |
返回的 data:UIActionResult
批量动作、流程宏与运行报告
运行流程宏
POST /cloudphone/automation/envs/{id}/flows
校验流程宏 yunyoo.flow/2 后作为异步任务执行,返回任务编号,用查询任务跟踪;偏离时任务以 53019 结束并带偏离报告。
作用域:ui-action。权限:env.remote.control(远程操控)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | FlowRunInput | 是 | 流程宏与变量 |
返回的 data:FlowStarted
批量动作
POST /cloudphone/automation/envs/{id}/ui/batch
一次提交多步界面与应用动作并逐步执行,步骤结构与流程宏 yunyoo.flow/2 相同,最多 50 步、60 秒;缺省遇到首个失败即停,返回逐步结果与失败位置;需要确认时返回确认单与续跑位置(from、at、sub)
作用域:ui-action。权限:env.remote.control(远程操控)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | UIBatchInput | 是 | 步骤与变量 |
返回的 data:FlowView
校验流程宏
POST /cloudphone/automation/flows/check
只校验流程宏或步骤列表的格式,返回步数、运行时要传入的变量与用到的密码占位名,不执行。
作用域:ui-action。权限:env.remote.control(远程操控)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| 请求体 | FlowCheckInput | 是 | 流程宏或步骤列表 |
返回的 data:FlowCheckView
列出运行记录
GET /cloudphone/automation/runs
按时间倒序列出运行记录。
权限:automation.report.view(查看自动化运行记录)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
env | 查询 | integer | 否 | 只看这台设备 |
limit | 查询 | integer | 否 | 最多返回的条数 |
返回的 data:{list: RunView[]}。
运行报告
GET /cloudphone/automation/runs/{rid}
取一次运行的报告:各步的工具、参数摘要、目标元素、生效判定、结果码与耗时。
权限:automation.report.view(查看自动化运行记录)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
rid | 路径 | string | 是 | 运行编号 |
返回的 data:RunView
生成流程宏草稿
GET /cloudphone/automation/runs/{rid}/flow
从一次运行记录生成流程宏草稿;只取成功的动作,输入文字不能照录时改为变量 INPUT_n。
权限:automation.report.view(查看自动化运行记录)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
rid | 路径 | string | 是 | 运行编号 |
返回的 data:Drafted
确认单与人工交接
查询确认单
GET /cloudphone/automation/confirmations/{cid}
查询确认单的状态;带 wait 时最多等待这么多秒,直到状态不再是 pending。
权限:env.view(查看环境)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
cid | 路径 | string | 是 | 确认单编号 |
wait | 查询 | integer | 否 | 最长等待秒数,0–60 |
返回的 data:ConfirmationView
撤回确认单
POST /cloudphone/automation/confirmations/{cid}/cancel
撤回还在等待的确认单;撤回后带它重发返回 53011。
权限:env.view(查看环境)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
cid | 路径 | string | 是 | 确认单编号 |
返回的 data:ConfirmationView
人工交接
POST /cloudphone/automation/envs/{id}/handoff
请用户接手这台设备,reason 写明原因;交接期间动作类接口返回 53014,用户在查看器里交还后恢复;不带 reason 时只查询当前控制状态。
作用域:ui-action。权限:env.remote.control(远程操控)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | HandoffReq | 否 | 交接原因 |
返回的 data:ControlView
应用
应用操作
POST /cloudphone/automation/envs/{id}/app-op
启动、停止、清除数据、卸载或更新应用;卸载与清除数据属于高风险操作,需要用户确认时返回确认单。
作用域:app。权限:其中之一:app.operate(启动与停止应用)、app.remove(卸载应用)、app.install(安装应用)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | AppOpInput | 是 | 操作与包名 |
返回的 data:RunCommandResult
列出应用
GET /cloudphone/automation/envs/{id}/apps
format=list 时返回包名与可读名称;不带时返回旧版的设备侧列举结果,新接入请带 format=list。
作用域:app。权限:app.view(浏览应用)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
format | 查询 | string | 否 | list |
返回的 data:AppListView
安装应用
POST /cloudphone/automation/envs/{id}/apps
从应用库安装应用,返回安装任务,用查询任务跟踪。
作用域:app。权限:app.install(安装应用)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | AppInstallReq | 是 | 应用库里的应用编号 |
返回的 data:AgentTask
文件
取回文件
POST /cloudphone/automation/envs/{id}/files/pull
从设备取回一个文件,返回任务;任务完成后,查询任务给出 15 分钟内有效的下载链接。
作用域:file。权限:env.file.download(下载文件)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | FilePullReq | 是 | 设备上的文件路径 |
返回的 data:AgentTask
推送文件
POST /cloudphone/automation/envs/{id}/files/push
把已上传的文件推到设备的下载目录,返回推送任务。
作用域:file。权限:env.file.upload(上传文件)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | FilePushReq | 是 | 上传会话的 token |
返回的 data:AgentTask
创建上传会话
POST /cloudphone/automation/envs/{id}/files/upload-session
为要推到设备的文件创建上传会话;按返回的地址上传后,用其中的 token 调用推送文件。
作用域:file。权限:env.file.upload(上传文件)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | FileSessionReq | 是 | 文件名与大小 |
返回的 data:UploadSessionResp
开关机与任务
暂停
POST /cloudphone/automation/envs/{id}/pause
暂停运行并保留内存状态,只适用于本地节点上的环境;返回任务。
作用域:lifecycle。权限:env.stop(停止环境)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
返回的 data:{status: string, taskId: integer}。
重启
POST /cloudphone/automation/envs/{id}/reboot
重启设备,在后台进行。
作用域:lifecycle。权限:env.start(启动环境)、env.stop(停止环境)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
返回的 data 为空。
继续运行
POST /cloudphone/automation/envs/{id}/resume
让暂停的环境继续运行;返回任务。
作用域:lifecycle。权限:env.start(启动环境)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
返回的 data:{status: string, taskId: integer}。
开机
POST /cloudphone/automation/envs/{id}/start
开机,在后台进行。
作用域:lifecycle。权限:env.start(启动环境)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
返回的 data 为空。
关机
POST /cloudphone/automation/envs/{id}/stop
关机,在后台进行。
作用域:lifecycle。权限:env.stop(停止环境)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
返回的 data 为空。
同步到云端
POST /cloudphone/automation/envs/{id}/sync
把本地节点上环境的数据同步到云端。
作用域:lifecycle。权限:env.sync(同步到云端)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | EnvSyncReq | 否 | 同步参数 |
返回的 data 为空。
查询任务
GET /cloudphone/automation/tasks/{id}
查询异步任务(开关机、备份、文件推拉、应用安装、流程宏)的状态与结果,所需作用域随任务类型而定;文件取回完成且有下载文件权限时附 15 分钟内有效的下载链接。
权限:env.view(查看环境)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 任务编号 |
返回的 data:TaskView
备份与可移植包
列出备份
GET /cloudphone/automation/backups
列出一台设备的备份。
作用域:backup。权限:env.backup.view(查看备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
env | 查询 | integer | 是 | 环境 ID |
kind | 查询 | string | 否 | 只看这种类型的备份 |
返回的 data:{list: EnvBackup[]}。
封装可移植包
POST /cloudphone/automation/backups/{id}/package
把一份备份封装为可移植包,返回包编号与封装任务。
作用域:backup。权限:env.backup.export(导出备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 备份 ID |
| 请求体 | PackageCreateReq | 是 | 封装参数 |
返回的 data:PackageCreateResult
还原应用级备份
POST /cloudphone/automation/backups/{id}/restore-app
立即用应用级备份还原该应用,返回任务;属于高风险操作,需要用户确认时返回确认单。
作用域:backup。权限:env.backup.restore(还原备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 备份 ID |
| 请求体 | AppRestoreReq | 否 | 还原参数 |
返回的 data:{taskId: integer}。
创建整机备份
POST /cloudphone/automation/envs/{id}/backups
为设备创建整机备份。
作用域:backup。权限:env.backup.create(创建备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | BackupCreateReq | 是 | 备份参数 |
返回的 data:EnvBackup
创建应用级备份
POST /cloudphone/automation/envs/{id}/backups/app
只备份一个应用的数据。
作用域:backup。权限:env.backup.create(创建备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | AppBackupCreateReq | 是 | 应用与备份参数 |
返回的 data:EnvBackup
设置待还原备份
POST /cloudphone/automation/envs/{id}/restore
设置一份整机备份在下次开机时还原,backupId 为空时取消;属于高风险操作,需要用户确认时返回确认单。
作用域:backup。权限:env.backup.restore(还原备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | RestoreSetReq | 是 | 要还原的备份 |
返回的 data 为空。
包详情
GET /cloudphone/automation/packages/{pid}
查询可移植包的详情与分享情况。
作用域:backup。权限:env.backup.view(查看备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
pid | 路径 | string | 是 | 包编号 |
返回的 data:PackageDetail
下载包
GET /cloudphone/automation/packages/{pid}/download
以 302 跳转到包的预签名下载地址。
作用域:backup。权限:env.backup.export(导出备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
pid | 路径 | string | 是 | 包编号 |
返回 HTTP 302,跳转到下载地址。
分享备份包
POST /cloudphone/automation/packages/{pid}/shares
为包创建分享链接,令牌只在这次返回;需要用户确认时返回确认单。
作用域:backup。权限:env.backup.share(分享备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
pid | 路径 | string | 是 | 包编号 |
| 请求体 | ShareCreateReq | 否 | 有效期与下载次数 |
返回的 data:ShareCreateResult
导入包
POST /cloudphone/automation/packages/import
把包导入为还原、数据环境、应用、档案或新环境;目标环境须在凭据范围内;dryRun 为 true 时只返回导入计划。
作用域:backup。权限:env.backup.import(导入备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| 请求体 | PackageImportReq | 是 | 导入目标与参数 |
返回的 data:PackageImportResult
检视上传的包
POST /cloudphone/automation/packages/inspect
读取已上传的包的元数据,导入前用它确认内容。
作用域:backup。权限:env.backup.import(导入备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| 请求体 | PackageInspectReq | 是 | 上传会话 |
返回的 data:PackageDetail
创建包上传会话
POST /cloudphone/automation/packages/upload-session
为要导入的包创建上传会话。
作用域:backup。权限:env.backup.import(导入备份)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| 请求体 | PackageUploadReq | 是 | 文件名与大小 |
返回的 data:packageUploadSession
多设备批量
多设备批量动作
POST /cloudphone/automation/batch
对分组、标签或设备列表选中的多台设备执行同一个界面动作、应用操作或命令,逐台返回结果,一台失败不影响其它设备;所需作用域随 kind 而定。
权限:。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| 请求体 | BatchInput | 是 | 选择器与动作 |
返回的 data:BatchItemResult[]。
逃生舱
本地通道桥接
POST /cloudphone/automation/envs/{id}/connect
建立本地通道桥接会话;逃生舱,需要 local-bridge 作用域,缺省不授予;建立后经 tunnel 连接数据面。
作用域:local-bridge。权限:env.adb.connect(ADB 连接)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
返回的 data:ConnectResp
执行命令
POST /cloudphone/automation/envs/{id}/run-command
在设备上执行命令;逃生舱,需要 run-command 作用域,缺省不授予;只在界面与应用接口做不到时使用。
作用域:run-command。权限:env.shell(终端与执行命令)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
| 请求体 | RunCommandInput | 是 | 命令与参数 |
返回的 data:RunCommandView
桥接数据面
GET /cloudphone/automation/envs/{id}/tunnel
升级为 WebSocket 后双向转发桥接的字节流。
作用域:local-bridge。权限:env.adb.connect(ADB 连接)。
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | 路径 | integer | 是 | 环境 ID |
返回 HTTP 101,已升级为 WebSocket。
数据类型
下面是请求体与返回中用到的数据类型,按名称排序。
AgentTask
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
ID | integer | 否 | 主键ID |
backupId | integer | 否 | |
createdAt | string | 否 | 创建时间 |
detail | string | 否 | |
envId | integer | 否 | |
errorCode | string | 否 | |
expiresAt | string | 否 | |
message | string | 否 | |
parentId | integer | 否 | |
percent | integer | 否 | |
providerId | integer | 否 | |
sessionId | integer | 否 | |
stage | string | 否 | |
status | string | 否 | |
type | string | 否 | |
updatedAt | string | 否 | 更新时间 |
AppBackupCreateReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
includeObb | boolean | 否 | 同时备份应用的 OBB 数据 |
package | string | 是 | 应用包名 |
target | string | 否 | 存放位置:cloud(缺省)或 local(只存在环境所在的本地节点) |
AppInstallReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
appIds | integer[] | 是 | 应用库里的应用编号 |
AppItem
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
label | string | 否 | 可读名称 |
package | string | 否 | 包名 |
versionName | string | 否 | 版本名 |
AppListView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
apps | AppItem[] | 否 | 已安装的应用 |
device | string | 否 | 设备,写作 env:<环境 ID> |
note | string | 否 | 改为设备侧列举时的说明 |
source | string | 否 | 清单来源:platform(平台清单)或 device(设备侧列举) |
AppOpInput
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
activity | string | 否 | 启动时指定的页面 |
keepData | boolean | 否 | 卸载时保留数据 |
op | string | 是 | 操作:launch、stop、clear、uninstall 或 update |
package | string | 是 | 应用包名 |
AppRestoreReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
ignoreVersion | boolean | 否 | 应用版本与备份不一致时照常还原 |
AttestationView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
check | AttestCheckView | 否 | |
delivery | string | 否 | |
enrollmentStatus | string | 否 | |
keyboxFingerprint | string | 否 | |
keyboxRef | integer | 否 | |
keyboxStatus | string | 否 | |
leaseStatus | string | 否 | |
locked | boolean | 否 | |
mode | string | 否 | |
runtimeMode | string | 否 | |
source | string | 否 | |
strongIntegrity | boolean | 否 | |
supply | string | 否 | |
trust | string | 否 |
AttestCheckView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
checkedAt | string | 否 | |
failed | string | 否 | |
keyboxMatch | boolean | 否 | |
rootKind | string | 否 | |
state | string | 否 |
AttestSource
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
keyboxId | integer | 否 | kind 为 user 时的 keybox 编号 |
kind | string | 否 | pool(平台,缺省)或 user(自己的 keybox) |
automation.Bounds
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
bottom | number | 否 | |
left | number | 否 | |
right | number | 否 | |
top | number | 否 |
automation.Selector
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
class | string | 否 | 类名 |
desc | string | 否 | 描述 |
id | string | 否 | 资源 ID |
index | integer | 否 | 同样条件命中多个时的序号,从 0 起 |
text | string | 否 | 文字等于 |
textContains | string | 否 | 文字包含 |
textRegex | string | 否 | 文字匹配的正则 |
BackupCreateReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
dataEnvId | integer | 否 | 要备份的数据环境,缺省为当前使用的数据环境 |
ignoreWindow | boolean | 否 | 本地 Linux 节点上不等备份时间窗,立即执行 |
kind | string | 否 | 备份类型:full(缺省)或 incremental |
name | string | 否 | 备份名称 |
parentBackupId | integer | 否 | 增量备份所基于的备份 |
target | string | 否 | 存放位置:cloud(缺省)或 local(只存在环境所在的本地节点) |
BackupShare
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
ID | integer | 否 | 主键ID |
createdAt | string | 否 | 创建时间 |
createdBy | integer | 否 | |
downloadCount | integer | 否 | |
expiresAt | string | 否 | |
lastDownloadAt | string | 否 | |
maxDownloads | integer | 否 | |
packageId | integer | 否 | |
requireLogin | boolean | 否 | |
revokedAt | string | 否 | |
updatedAt | string | 否 | 更新时间 |
BatchInput
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
appOp | AppOpInput | 否 | kind 为 app-op 时的应用操作 |
command | RunCommandInput | 否 | kind 为 run-command 时的命令 |
kind | string | 是 | 动作类型:ui-action、app-op 或 run-command |
selector | SelectorSpec | 否 | 选中的设备 |
uiAction | UIActionInput | 否 | kind 为 ui-action 时的界面动作 |
BatchItemResult
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
envId | integer | 否 | 环境 ID |
error | string | 否 | 失败原因 |
ok | boolean | 否 | 这台设备是否成功 |
result | any | 否 | 这台设备的结果,结构与单台接口相同 |
Candidate
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
line | string | 否 | 元素的紧凑行 |
ref | string | 否 | 元素编号 |
score | number | 否 | |
selectors | automation.Selector[] | 否 | 在当前界面唯一的选择器建议 |
ConfirmationView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
action | string | 否 | 被挂起的动作 |
categories | string[] | 否 | 风险类别 |
clientName | string | 否 | 发起方客户端 |
createdAt | string | 否 | 创建时间 |
decidedAt | string | 否 | 决定时间 |
envId | integer | 否 | 环境 ID |
executedAt | string | 否 | 执行时间 |
expiresAt | string | 否 | 过期时间 |
id | string | 否 | 确认单编号 |
intent | string | 否 | 调用方声明的意图 |
skillName | string | 否 | 发起方 Skill |
status | string | 否 | pending、approved、denied、expired、cancelled 或 executed |
summary | string | 否 | 动作摘要 |
thumb | string | 否 | 动作前的截图 |
tokenKind | string | 否 | 发起方凭据的种类 |
tokenName | string | 否 | 发起方凭据的名称 |
url | string | 否 | 确认页地址 |
ConnectResp
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
expiresAt | string | 否 | 过期时间 |
hint | string | 否 | 使用说明 |
sessionId | string | 否 | 桥接会话编号 |
ControlView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
byYou | boolean | 否 | 是否由当前用户接管 |
enabled | boolean | 否 | 是否开启了人工接管 |
envId | integer | 否 | 环境 ID |
lastActionAt | string | 否 | 最近一次自动化动作的时间 |
reason | string | 否 | 交接原因 |
since | string | 否 | 进入当前状态的时间 |
state | string | 否 | 控制状态:free、automating、human 或 waiting-human |
url | string | 否 | 查看器地址 |
Deviation
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
candidates | Candidate[] | 否 | |
command | string | 否 | |
expect | Identity | 否 | |
foreground | string | 否 | |
found | Hit | 否 | |
path | string | 否 | |
reason | string | 否 | |
resume | integer | 否 | |
screen | string | 否 | |
selector | flow.Selector | 否 | |
step | integer | 否 |
Drafted
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
flow | 流程宏 yunyoo.flow/2 | 否 | 生成的流程宏 |
skipped | integer | 否 | 没有收进草稿的步数 |
vars | string[] | 否 | 运行时要传入的变量,对应不能照录的输入 |
EnvBackup
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
ID | integer | 否 | 主键ID |
actorUserId | integer | 否 | |
androidVersion | string | 否 | |
appPackage | string | 否 | |
appVersionCode | integer | 否 | |
boundPackage | string | 否 | |
chainDepth | integer | 否 | |
createdAt | string | 否 | 创建时间 |
dataEnvId | integer | 否 | |
deviceProfile | string | 否 | |
envId | integer | 否 | |
errorCode | string | 否 | |
expiresAt | string | 否 | |
format | integer | 否 | |
hasRuntimeState | boolean | 否 | |
hasSecureState | boolean | 否 | |
identityMatch | boolean | 否 | |
importPackageId | integer | 否 | |
kind | string | 否 | |
location | string | 否 | |
name | string | 否 | |
nodeId | integer | 否 | |
parentBackupId | integer | 否 | |
plainSize | integer | 否 | |
purpose | string | 否 | |
remark | string | 否 | |
retryCount | integer | 否 | |
rootVariant | string | 否 | |
scheduledAt | string | 否 | |
source | string | 否 | |
status | string | 否 | |
updatedAt | string | 否 | 更新时间 |
usedBytes | integer | 否 |
EnvScopeSpec
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
envIds | integer[] | 否 | kind 为 env 时的环境 |
groupIds | integer[] | 否 | kind 为 group 时的分组 |
kind | string | 否 | 范围:all、group 或 env |
EnvSummary
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
groupId | integer | 否 | 分组 ID |
id | integer | 否 | 环境 ID |
status | string | 否 | 状态 |
title | string | 否 | 名称 |
EnvSyncReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
stopAndSync | boolean | 否 | 为 true 时先关机再同步 |
FilePullReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 是 | 设备上的文件路径 |
FilePushReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 是 | 上传会话返回的 token |
FileSessionReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 文件名 |
size | integer | 是 | 文件字节数 |
flow.Selector
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
class | string | 否 | 类名 |
desc | string | 否 | 描述 |
id | string | 否 | 资源 ID |
index | integer | 否 | 同样条件命中多个时的序号,从 0 起 |
point | Point | 否 | 元素定位不到时的后备坐标,取屏幕宽高的比例 |
text | string | 否 | 文字等于 |
textContains | string | 否 | 文字包含 |
textRegex | string | 否 | 文字匹配的正则 |
FlowCheckInput
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
flow | object | 否 | 要校验的流程宏,与 steps 二选一 |
steps | object[] | 否 | 要校验的步骤列表 |
vars | object | 否 | 已知的变量取值 |
FlowCheckView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
secrets | string[] | 否 | 用到的密码占位名,值由调用方在本机取得 |
steps | integer | 否 | 步数 |
vars | string[] | 否 | 运行时要传入的变量 |
FlowRunInput
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
at | string | 否 | 暂停时返回的步骤位置 |
confirmation | string | 否 | 已批准的确认单编号,与暂停时返回的 pause 一起续跑 |
flow | object | 否 | 流程宏 yunyoo.flow/2 的内容 |
from | integer | 否 | 续跑时从第几个顶层步骤开始,从 1 起 |
secrets | object | 否 | 密码占位的取值,只在内存中保存到运行结束 |
sub | integer | 否 | 暂停时返回的受控动作序号 |
vars | object | 否 | 变量取值 |
FlowStarted
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
runId | string | 否 | 运行编号 |
steps | integer | 否 | 步数 |
taskId | integer | 否 | 任务编号,用查询任务跟踪 |
FlowView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | integer | 否 | 没有通过时的错误码 |
confirmation | ConfirmationView | 否 | 等待批准的确认单 |
deviation | Deviation | 否 | 偏离报告:步骤位置、期望的元素、当前界面摘要与相近元素 |
failed | StepResult | 否 | 第一个失败的步骤 |
inspect | string | 否 | 结束时的紧凑快照 |
message | string | 否 | 没有通过的原因 |
pause | Pause | 否 | 需要确认时暂停的位置,续跑时带上 |
resume | integer | 否 | 续跑时从第几步开始,从 1 起;0 表示从头 |
runId | string | 否 | 运行编号 |
status | string | 否 | passed、failed、deviated、paused、cancelled 或 limited |
steps | StepResult[] | 否 | 逐步结果 |
HandoffReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
reason | string | 否 | 交接原因,显示给接手的用户;为空时只查询当前控制状态 |
Hit
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
line | string | 否 | 元素的紧凑行 |
ref | string | 否 | 元素编号 |
selectors | automation.Selector[] | 否 | 在当前界面唯一的选择器建议 |
Identity
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
class | string | 否 | |
desc | string | 否 | |
id | string | 否 | |
text | string | 否 |
ImportEnvSpec
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
attestationSource | AttestSource | 否 | 证明来源,缺省为平台 |
bindAck | boolean | 否 | 确认改为绑定后,绑定应用之外的第三方应用会被停用 |
bindAppId | integer | 否 | 绑定的应用,缺省沿用包的来源 |
dataGib | integer | 否 | 磁盘档位(GiB) |
deviceId | integer | 否 | 本地节点上的槽位 |
deviceSource | string | 否 | 设备来源:owned(已购设备)或 temporary(临时设备) |
egressConfirm | string | 否 | 预检返回的出口确认令牌,代理与包内锚点需要确认时使用 |
groupId | integer | 否 | 分组 |
proxyId | integer | 否 | 代理 |
remark | string | 否 | 备注 |
skuId | integer | 否 | 规格编号 |
tagIds | integer[] | 否 | 标签 |
title | string | 否 | 名称 |
ImportPlan
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
anchor | object | 否 | 包内的出口锚点 |
attestation | string | 否 | 证明来源 |
bindAck | boolean | 否 | 目标环境已绑定应用而包的来源未绑定,正式导入时须带 bindAck |
boundPackage | string | 否 | 以包新建环境时沿用的绑定应用包名;来源未绑定时为空 |
confirmToken | string | 否 | 出口需要确认时的确认令牌,正式导入时作为 egressConfirm 传入 |
deviceProfile | string | 否 | 包对应的机型 |
format | integer | 否 | 包格式版本 |
hasSeed | boolean | 否 | 包内是否带设备身份种子 |
identity | string | 否 | 身份处理结果 |
identityPublic | object | 否 | 包内设备身份的公开派生值,已脱敏 |
kind | string | 否 | 包的类型 |
mode | string | 否 | 导入方式 |
proxyGrade | string | 否 | 代理与锚点的一致程度 |
rootVariant | string | 否 | 包对应的变体 |
runtimeState | boolean | 否 | 是否会恢复运行态 |
secureState | boolean | 否 | 是否会恢复安全状态 |
skuName | string | 否 | 新建环境的规格名称 |
title | string | 否 | 新建环境的名称 |
verify | boolean | 否 | 正式导入时须带账号密码复核 |
ImportTarget
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
env | ImportEnvSpec | 否 | mode 为 env 时新环境的参数 |
envId | integer | 否 | 目标环境;mode 为 env 时不填 |
mode | string | 是 | 导入方式:restore、data-env、app、profile 或 env(新建环境) |
Node
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
bounds | automation.Bounds | 否 | 元素在屏幕上的范围(像素) |
checkable | boolean | 否 | |
checked | boolean | 否 | |
children | Node[] | 否 | 子元素 |
className | string | 否 | 类名 |
clickable | boolean | 否 | |
contentDesc | string | 否 | 描述 |
editable | boolean | 否 | |
elementId | string | 否 | 稳定元素标识 |
enabled | boolean | 否 | |
focusable | boolean | 否 | |
focused | boolean | 否 | |
longClickable | boolean | 否 | |
package | string | 否 | 所属应用包名 |
password | boolean | 否 | 是否为密码框,密码框不返回文字 |
ref | string | 否 | 元素编号 |
resourceId | string | 否 | 资源 ID |
scrollable | boolean | 否 | |
selected | boolean | 否 | |
text | string | 否 | 文字 |
NodeDoctor
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
failed | string[] | 否 | 没有通过的检查项 |
ok | boolean | 否 | 体检是否通过 |
NodeSlots
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
total | integer | 否 | 槽位总数 |
used | integer | 否 | 已用槽位 |
NodeSummary
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
doctor | NodeDoctor | 否 | 本地节点的体检结果 |
execMode | string | 否 | 本地节点的运行方式 |
lastSeenAt | string | 否 | 最近一次在线的时间 |
name | string | 否 | 名称 |
nodeType | string | 否 | 节点类型 |
online | boolean | 否 | 是否在线 |
platform | string | 否 | 本地节点的系统平台 |
providerId | integer | 否 | 节点 ID |
scope | string | 否 | cloud(云端节点)或 local(本地节点) |
slots | NodeSlots | 否 | 槽位用量 |
NormPoint
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
x | number | 否 | 横坐标,占屏幕宽度的比例,0–1 |
y | number | 否 | 纵坐标,占屏幕高度的比例,0–1 |
PackageCreateReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
escrow | boolean | 否 | 旧格式口令包托管成员密钥,以便找回口令;只对付费用户开放 |
identityTransfer | boolean | 否 | 同意把包内的设备身份转移给导入方 |
includeSecureState | boolean | 否 | 是否携带安全状态,整机包缺省携带 |
includeSeed | boolean | 否 | 是否携带设备身份种子 |
kdf | PackageKDF | 否 | 派生 wrapKeyB64 所用的参数 |
password | string | 否 | 账号密码,携带设备身份时用于复核 |
wrapKeyB64 | string | 否 | 旧格式口令包的包装密钥(base64),由口令在本机派生;平台开启密封导出时不需要 |
PackageCreateResult
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
fileName | string | 否 | 包文件名 |
packageId | string | 否 | 包编号 |
taskId | integer | 否 | 封装任务编号 |
PackageDetail
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
ID | integer | 否 | 主键ID |
actorUserId | integer | 否 | |
androidVersion | string | 否 | |
appPackage | string | 否 | |
backupId | integer | 否 | |
createdAt | string | 否 | 创建时间 |
deviceProfile | string | 否 | |
downloadCount | integer | 否 | |
envId | integer | 否 | |
envSegment | boolean | 否 | |
errorCode | string | 否 | |
errorMsg | string | 否 | |
escrow | boolean | 否 | |
expiresAt | string | 否 | |
fileName | string | 否 | |
format | integer | 否 | |
hasRuntimeState | boolean | 否 | |
hasSecureState | boolean | 否 | |
hasSeed | boolean | 否 | |
identityTransfer | boolean | 否 | |
kdf | PackageKDF | 否 | |
keyId | string | 否 | |
kind | string | 否 | |
originShareId | integer | 否 | |
packageId | string | 否 | |
rewrapCount | integer | 否 | |
rootVariant | string | 否 | |
shares | BackupShare[] | 否 | |
sizeBytes | integer | 否 | |
source | string | 否 | |
status | string | 否 | |
taskId | integer | 否 | |
updatedAt | string | 否 | 更新时间 |
PackageImportReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
bindAck | boolean | 否 | 目标环境已绑定应用而包的来源未绑定时确认导入,绑定应用之外的第三方应用会被停用 |
dataEnvName | string | 否 | 导入为数据环境时的名称 |
dryRun | boolean | 否 | 为 true 时只返回导入计划,不创建任务 |
fileName | string | 否 | 上传的文件名 |
identityMode | string | 否 | 导入为档案时的身份处理:template(只取设置,身份不变)或 transfer(改持包内身份) |
identityTransfer | boolean | 否 | 机器凭据改持包内身份时必须为 true |
ignoreVersion | boolean | 否 | 版本不一致时照常导入 |
packageId | string | 否 | 已有的包编号,与 uploadSessionId 二选一 |
password | string | 否 | 账号密码,用于敏感操作复核 |
restoreIdentity | boolean | 否 | 是否改持包内的设备身份,缺省为 true |
target | ImportTarget | 是 | 导入目标 |
uploadSessionId | string | 否 | 上传会话编号 |
wrapKeyB64 | string | 否 | 旧格式口令包的包装密钥,按检视结果里的 kdf 在本机派生;平台密封的包不需要 |
PackageImportResult
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
packageId | string | 否 | 包编号 |
plan | ImportPlan | 否 | dryRun 时的导入计划 |
taskId | integer | 否 | 导入任务编号;dryRun 时为空 |
PackageInspectReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
fileName | string | 否 | 包文件名 |
uploadSessionId | string | 是 | 上传会话编号 |
PackageKDF
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
iterations | integer | 否 | 迭代次数 |
saltB64 | string | 否 | 盐(base64) |
PackageUploadReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
fileName | string | 是 | 包文件名,扩展名为 .wp |
size | integer | 是 | 包字节数 |
packageUploadSession
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
headers | object | 否 | 上传时要带的请求头 |
mode | string | 否 | 上传方式 |
partSize | integer | 否 | 分片大小(字节) |
parts | UploadPartURL[] | 否 | 分片上传地址 |
uploadSessionId | string | 否 | 上传会话编号 |
url | string | 否 | 整体上传的地址 |
Pause
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
confirmation | string | 否 | 等待批准的确认单编号 |
path | string | 否 | 暂停的步骤位置 |
step | integer | 否 | 暂停的顶层步骤号 |
sub | integer | 否 | 这一步里第几个受控动作,从 0 起 |
Point
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
x | number | 否 | |
y | number | 否 |
provider.Bounds
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
bottom | number | 否 | |
left | number | 否 | |
right | number | 否 | |
top | number | 否 |
RefCandidate
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
bounds | provider.Bounds | 否 | |
className | string | 否 | |
contentDesc | string | 否 | |
ref | string | 否 | |
resourceId | string | 否 | |
text | string | 否 |
RestoreSetReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
backupId | integer | 否 | 要还原的整机备份,为空时取消待还原 |
bindAck | boolean | 否 | 目标环境已绑定应用而备份来源未绑定时确认还原,绑定应用之外的第三方应用会被停用 |
password | string | 否 | 账号密码,用于敏感操作复核 |
RunCommandInput
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
argv | string[] | 是 | 命令与参数 |
cwd | string | 否 | 工作目录 |
env | object | 否 | 附加的环境变量 |
mode | string | 否 | sync(缺省,等待结果)或 async(立即返回任务) |
shell | boolean | 否 | 为 true 时经 shell 解释 |
timeoutMs | integer | 否 | 超时上限,毫秒 |
RunCommandResult
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
channel | string | 否 | 执行通道 |
duration_ms | integer | 否 | 耗时,毫秒 |
exit_code | integer | 否 | 退出码 |
invoke_id | string | 否 | 调用编号 |
output_bytes | integer | 否 | 输出字节数 |
status | string | 否 | succeeded、failed 或 timed_out |
stderr | string | 否 | 标准错误输出 |
stderr_truncated | boolean | 否 | 标准错误输出是否被截断 |
stdout | string | 否 | 标准输出 |
stdout_truncated | boolean | 否 | 标准输出是否被截断 |
RunCommandView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
channel | string | 否 | 执行通道 |
durationMs | integer | 否 | 耗时,毫秒 |
exitCode | integer | 否 | 退出码 |
invokeId | string | 否 | 调用编号 |
outputBytes | integer | 否 | 输出字节数 |
outputUrl | string | 否 | 输出过大时转存的下载地址 |
status | string | 否 | succeeded、failed、timed_out 或 accepted(async 已受理) |
stderr | string | 否 | 标准错误输出 |
stderrTruncated | boolean | 否 | 标准错误输出是否被截断 |
stdout | string | 否 | 标准输出 |
stdoutTruncated | boolean | 否 | 标准输出是否被截断 |
taskId | integer | 否 | mode 为 async 时的任务编号,用查询任务跟踪 |
RunView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
clientName | string | 否 | 客户端 |
endedAt | string | 否 | 结束时间 |
entry | string | 否 | 入口 |
envId | integer | 否 | 环境 ID |
failedSteps | integer | 否 | 失败的步数 |
id | string | 否 | 运行编号 |
items | StepView[] | 否 | 各步记录 |
skillName | string | 否 | Skill |
startedAt | string | 否 | 开始时间 |
status | string | 否 | 运行结果 |
steps | integer | 否 | 步数 |
tokenKind | string | 否 | 凭据种类 |
tokenName | string | 否 | 凭据名称 |
ScreenshotView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
annotated | boolean | 否 | 是否标出了元素编号 |
format | string | 否 | jpeg 或 png |
height | integer | 否 | 图像高度 |
image_base64 | string | 否 | 图像内容(base64) |
notes | string[] | 否 | 处理说明 |
scale | number | 否 | 图像相对原始分辨率的缩放比例 |
snapshot | integer | 否 | 标注所用的快照版本 |
source_height | integer | 否 | 屏幕原始高度 |
source_width | integer | 否 | 屏幕原始宽度 |
width | integer | 否 | 图像宽度 |
SelectorSpec
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
envIds | integer[] | 否 | 选中这些环境 |
groupId | integer | 否 | 选中这个分组里的设备 |
tagId | integer | 否 | 选中带这个标签的设备 |
ShareCreateReq
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
expiresInHours | integer | 否 | 有效小时数 |
identityTransfer | boolean | 否 | 同意包内的设备身份随分享转移;带设备身份的包必须为 true |
maxDownloads | integer | 否 | 最多下载次数 |
requireLogin | boolean | 否 | 已不再生效,领取一律要求登录 |
ShareCreateResult
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
expiresAt | string | 否 | 过期时间 |
shareId | integer | 否 | 分享编号 |
shareUrl | string | 否 | 分享链接,领取要求登录 |
token | string | 否 | 分享令牌,只在这次返回 |
StatusView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
capabilities | string[] | 否 | 能力位,如 textInput、refIdentity |
control | string | 否 | 控制状态:free、automating、human 或 waiting-human |
degraded | boolean | 否 | 是否为降级档 |
interactable | boolean | 否 | 当前是否可交互 |
protocol | string | 否 | 自动化协议版本 |
StepResult
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | integer | 否 | 错误码 |
command | string | 否 | 步骤命令 |
durationMs | integer | 否 | 耗时,毫秒 |
effect | string | 否 | 生效判定 |
label | string | 否 | 步骤标签 |
message | string | 否 | 失败原因 |
ok | boolean | 否 | 是否成功 |
path | string | 否 | 步骤位置,如 steps[3] |
skipped | boolean | 否 | 是否跳过 |
step | integer | 否 | 顶层步骤号,从 1 起 |
StepView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
at | string | 否 | 时间 |
code | integer | 否 | 结果码 |
confirmation | string | 否 | 关联的确认单 |
durationMs | integer | 否 | 耗时,毫秒 |
effect | string | 否 | 生效判定 |
entry | string | 否 | 入口 |
identity | string | 否 | 目标元素的标识 |
intent | string | 否 | 调用方声明的意图 |
params | string | 否 | 参数摘要 |
seq | integer | 否 | 步序号 |
target | string | 否 | 目标元素 |
thumb | string | 否 | 动作后的截图 |
tool | string | 否 | 工具 |
trace | string | 否 | 追踪编号 |
TaskView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
ID | integer | 否 | 主键ID |
backupId | integer | 否 | |
createdAt | string | 否 | 创建时间 |
detail | string | 否 | |
envId | integer | 否 | |
errorCode | string | 否 | |
expiresAt | string | 否 | |
message | string | 否 | |
parentId | integer | 否 | |
percent | integer | 否 | |
providerId | integer | 否 | |
result | object | 否 | 任务结果;流程宏为执行报告 |
sessionId | integer | 否 | |
stage | string | 否 | |
status | string | 否 | |
type | string | 否 | |
updatedAt | string | 否 | 更新时间 |
UIActionInput
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
action | string | 否 | 动作名;单台设备的动作接口由路径决定,可以不填;多设备批量时必填:tap、swipe、type 或 key |
activity | string | 否 | until 为 package 时一并要求的页面 |
clear | boolean | 否 | 为 true 时先清空输入框 |
code | integer | 否 | Android 按键码 |
durationMs | integer | 否 | 滑动时长,毫秒 |
editorAction | integer | 否 | 输入法动作编号 |
from | NormPoint | 否 | 滑动起点,归一化坐标 |
idleMs | integer | 否 | until 为 idle 时,界面要保持不变的毫秒数 |
longPressMs | integer | 否 | 大于 0 时长按这么多毫秒 |
package | string | 否 | until 为 package 时要等到前台的应用包名 |
point | NormPoint | 否 | 归一化坐标,没有可用的元素时代替 selector |
selector | object | 否 | 元素选择器:{"by":"element","id":"e12","snapshot":7}(元素编号,带上快照版本)、{"by":"resourceId","value":"…"}、{"by":"text","value":"…"}、{"by":"contentDesc","value":"…"} 或 {"by":"point","point":{"x":0.5,"y":0.5}} |
submit | boolean | 否 | 为 true 时输入后发送回车 |
text | string | 否 | 要输入的文本 |
timeoutMs | integer | 否 | 等待上限,毫秒 |
to | NormPoint | 否 | 滑动终点,归一化坐标 |
until | string | 否 | 等待条件:gone、idle、animation 或 package;为空时等 selector 指定的元素出现 |
verify | boolean | 否 | 为 true 时等界面稳定后判定动作是否生效 |
UIActionResult
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
activity | string | 否 | 动作后的前台页面 |
candidates | RefCandidate[] | 否 | 目标不唯一时的候选元素 |
effect | string | 否 | 生效判定:changed 为界面有变化,unchanged 为没有变化,unverified 为没有判定 |
error_code | integer | 否 | 未完成时的错误码 |
matched | boolean | 否 | 等待时是否等到了目标 |
message | string | 否 | 未完成的原因 |
ok | boolean | 否 | 动作是否完成 |
package | string | 否 | 动作后的前台应用包名 |
snapshot | object | 否 | 部分环境在动作后附带的界面结构 |
snapshot_version | integer | 否 | 动作后的快照版本 |
target | RefCandidate | 否 | 实际操作的元素 |
timed_out | boolean | 否 | 是否等待超时 |
UIBatchInput
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
at | string | 否 | 暂停时返回的步骤位置 |
confirmation | string | 否 | 已批准的确认单编号,与暂停时返回的 pause 一起续跑 |
from | integer | 否 | 续跑时从第几个顶层步骤开始,从 1 起 |
inspectAtEnd | boolean | 否 | 为 true 时在结果里附上结束时的紧凑快照 |
keepGoing | boolean | 否 | 为 true 时某步失败后继续执行 |
secrets | object | 否 | 密码占位的取值,只在内存中保存到运行结束 |
steps | object[] | 否 | 步骤列表,结构与流程宏 yunyoo.flow/2 的 steps 相同 |
sub | integer | 否 | 暂停时返回的受控动作序号 |
vars | object | 否 | 变量取值 |
UIFindInput
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
all | boolean | 否 | 为 true 时也在屏幕外与不可见的元素中查找 |
class | string | 否 | 类名,可只写最后一段 |
desc | string | 否 | 描述包含这段内容,不区分大小写 |
id | string | 否 | 资源 ID,可省略包名前缀 |
max | integer | 否 | 最多返回的命中数 |
regex | string | 否 | 文字或描述匹配这个正则 |
text | string | 否 | 文字包含这段内容,不区分大小写 |
UIFindView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
device | string | 否 | 设备,写作 env:<环境 ID> |
hits | Hit[] | 否 | 命中的元素,最多 max 个 |
snapshot | integer | 否 | 快照版本 |
text | string | 否 | 命中元素的紧凑行,一行一个 |
total | integer | 否 | 命中总数 |
UITreeView
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
activity | string | 否 | 前台页面 |
capabilities | string[] | 否 | 能力位,如 textInput、refIdentity |
degraded | boolean | 否 | 是否为降级档 |
device | string | 否 | 设备,写作 env:<环境 ID> |
format | string | 否 | compact 或 json |
height | integer | 否 | 屏幕高度(像素) |
package | string | 否 | 前台应用包名 |
protocol | string | 否 | 自动化协议版本 |
root | Node | 否 | format 为 json 时的界面树 |
snapshot | integer | 否 | 快照版本,按元素编号操作时带上 |
text | string | 否 | format 为 compact 时的紧凑快照 |
width | integer | 否 | 屏幕宽度(像素) |
UploadPartURL
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
partNumber | integer | 否 | |
url | string | 否 |
UploadSessionResp
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
headers | object | 否 | 上传时要带的请求头 |
token | string | 否 | 推送文件时使用的 token |
url | string | 否 | 上传地址,用 PUT 上传文件内容 |
WhoAmIResp
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
apps | string[] | 否 | 委派令牌允许操作的应用包名 |
dialogs | string[] | 否 | 应用名单之外照常允许的系统对话框包名 |
envScope | EnvScopeSpec | 否 | 凭据可以操作的设备范围 |
scopes | string[] | 否 | 凭据的作用域 |
sealedPackage | boolean | 否 | 为 true 时新导出的包由平台密封,封装不需要口令 |
tokenId | integer | 否 | 凭据 ID |
tools | string[] | 否 | 这个凭据可用的 MCP 工具,按工具清单的顺序 |
uid | string | 否 | 用户编号 |
userId | integer | 否 | 用户 ID |
