导航
OpenAPI 概览
最近更新时间：2025.10.30 14:41:35首次发布时间：2021.10.18 18:26:50
文档反馈
问问助手火山引擎云手机结合了云计算和超低延迟的音视频传输技术，通过跨终端虚拟云服务，为客户提供流畅、实时、高效的分布式云计算与边缘计算服务。
我们开放了云手机相关业务的 OpenAPI。本文档为您提供具体的 API 描述、语法、参数说明及示例等，您可以调用 API 管理云手机的服务资源。
实例管理
| API | 说明 |
|---|---|
| CreatePod | 创建实例 CreatePod |
| CreatePodOneStep | 创建安卓实例并部署应用 CreatePodOneStep |
| UpdatePod | 更新实例 UpdatePod |
| ResetPod | 实例重置 ResetPod |
| DetailPod | 查询实例详情 DetailPod |
| ListPod | 查询实例列表 ListPod |
| PodDataTransfer | 实例数据复制迁移 PodDataTransfer |
| GetPodAppList | 获取实例应用列表 GetPodAppList |
| GetPodMetric | 查询实例资源状态 GetPodMetric |
| PowerOffPod | 实例关机 PowerOffPod |
| PowerOnPod | 实例开机 PowerOnPod |
| PodMute | 暂停/恢复实例推流 PodMute |
| RebootPod | 重启实例 RebootPod |
| PodAdb | 打开/关闭实例 ADB PodAdb |
| PodStop | 停止实例推流 PodStop |
| PodDataDelete | 清理用户数据 PodDataDelete |
| DeletePod | 删除实例 DeletePod |
| SetProxy | 设置代理服务 SetProxy |
| BackupPod | 备份实例 BackupPod |
| CancelBackupPod | 取消备份实例 CancelBackupPod |
| RestorePod | 还原实例 RestorePod |
| CancelRestorePod | 取消还原实例 CancelRestorePod |
| MigratePod | 迁移实例 MigratePod |
| BackupData | 备份数据 BackupData |
| RestoreData | 恢复数据 RestoreData |
| ListBackupData | 查询备份数据 ListBackupData |
| DeleteBackupData | 删除备份数据 DeleteBackupData |
实例属性管理
| API | 说明 |
|---|---|
| UpdatePodProperty | 更新实例属性 UpdatePodProperty |
| GetPodProperty | 查询实例属性列表 GetPodProperty |
| AddPhoneTemplate | 添加机型库 AddPhoneTemplate |
| ListPhoneTemplate | 查询机型库列表 ListPhoneTemplate |
| GetPhoneTemplate | 查询机型库 GetPhoneTemplate |
| UpdatePhoneTemplate | 更新机型库 UpdatePhoneTemplate |
| RemovePhoneTemplate | 删除机型库 RemovePhoneTemplate |
云机管理
| API | 说明 |
|---|---|
| ListHost | 查询云机列表 ListHost |
| DetailHost | 查询云机详情 DetailHost |
| UpdateHost | 更新云机 UpdateHost |
| RebootHost | 重启云机 RebootHost |
| ResetHost | 重置云机 ResetHost |
镜像管理
| API | 说明 |
|---|---|
| ListImage | 查询镜像信息 ListImage |
| ListImageResource | 查询镜像分布 ListImageResource |
| GetImagePreheating | 查询镜像预热信息 GetImagePreheating |
| CreateImageOneStep | 镜像内置应用 CreateImageOneStep |
机房管理
| API | 说明 |
|---|---|
| ListDc | 获取机房列表 ListDc |
| GetDcBandwidthDailyPeak | 获取机房带宽日峰值 GetDcBandwidthDailyPeak |
资源管理
| API | 说明 |
|---|---|
| ListConfiguration | 查询套餐列表 ListConfiguration |
| ListPodResource | 查询实例资源列表 ListPodResource |
| UpdatePodResourceApplyNum | 更新订购实例数量 UpdatePodResourceApplyNum |
| ListResourceQuota | 查询资源配额 ListResourceQuota |
| GetProductResource | 查询业务存储资源 GetProductResource |
| UpdateProductResource | 更新业务存储资源 UpdateProductResource |
| SubscribeResourceAuto | 自动下单复购资源 SubscribeResourceAuto |
| RenewResourceAuto | 自动下单续订实例 RenewResourceAuto |
| ListPodResourceSet | 查询实例资源组列表 ListPodResourceSet |
| UnsubscribeHostResource | 退订后付费云机资源 UnsubscribeHostResource |
| ListInstanceConfigurationSpec | 查询实例规格列表 ListInstanceConfigurationSpec |
屏幕布局管理
| API | 说明 |
|---|---|
| ListDisplayLayoutMini | 查询基础版屏幕布局列表 ListDisplayLayoutMini |
| CreateDisplayLayoutMini | 创建基础版屏幕布局 CreateDisplayLayoutMini |
| DeleteDisplayLayout | 删除屏幕布局 DeleteDisplayLayout |
| DetailDisplayLayoutMini | 查询基础版屏幕布局详情 DetailDisplayLayoutMini |
应用管理
| API | 说明 |
|---|---|
| LaunchApp | 启动应用 LaunchApp |
| LaunchApps | 批量启动应用 LaunchApps |
| InstallApp | 安装应用 InstallApp |
| InstallApps | 批量安装应用 InstallApps |
| ListAppVersionDeploy | 查询应用版本部署信息列表 ListAppVersionDeploy |
| DetailApp | 查询应用信息 DetailApp |
| ListApp | 查询应用信息列表 ListApp |
| UninstallApp | 卸载应用 UninstallApp |
| UploadApp | 上传应用 UploadApp |
| UpdateApp | 修改应用 UpdateApp |
| AutoInstallApp | 自动下载安装应用 AutoInstallApp |
| DeleteApp | 删除应用 DeleteApp |
| CloseApp | 关闭应用 CloseApp |
| GetAppCrashLog | 查询应用崩溃 GetAppCrashLog |
| DeleteAppVersion | 删除应用版本 DeleteAppVersion |
云手机操控
| API | 说明 |
|---|---|
| StartRecording | 开始录屏 StartRecording |
| StopRecording | 停止录屏 StopRecording |
| PushFile | 上传文件 PushFile |
| PullFile | 下载文件 PullFile |
| RunCommand | 异步执行命令 RunCommand |
| RunSyncCommand | 同步执行命令 RunSyncCommand |
| BanUser | 封禁用户 BanUser |
| ScreenShot | 截图 ScreenShot |
| BatchScreenShot | 批量截图 BatchScreenShot |
标签管理
| API | 说明 |
|---|---|
| CreateTag | 创建标签 CreateTag |
| UpdateTag | 更新标签 UpdateTag |
| DeleteTag | 删除标签 DeleteTag |
| AttachTag | 实例打标签 AttachTag |
| ListTag | 查询标签列表 ListTag |
任务管理
| API | 说明 |
|---|---|
| GetTaskInfo | 查询任务详情 GetTaskInfo |
| ListTask | 查询任务列表信息 ListTask |
网络配置与管理
端口映射管理
| API | 说明 |
|---|---|
| CreatePortMappingRule | 创建端口映射规则 CreatePortMappingRule |
| BindPortMappingRule | 绑定端口映射规则 BindPortMappingRule |
| UnbindPortMappingRule | 解绑端口映射规则 UnbindPortMappingRule |
| DetailPortMappingRule | 查询端口映射详情 DetailPortMappingRule |
| ListPortMappingRule | 查询端口映射列表 ListPortMappingRule |
DNS 管理
| API | 说明 |
|---|---|
| CreateDNSRule | 创建 DNS 规则 CreateDNSRule |
| UpdateDNSRule | 更新 DNS 规则 UpdateDNSRule |
| DeleteDNSRule | 删除 DNS 规则 DeleteDNSRule |
| DetailDNSRule | 查询 DNS 规则详情 DetailDNSRule |
| ListDNSRule | 查询 DNS 规则列表 ListDNSRule |
自定义路由管理
| API | 说明 |
|---|---|
| AddCustomRoute | 创建自定义路由规则 AddCustomRoute |
| DeleteCustomRoute | 删除自定义路由规则 DeleteCustomRoute |
| ListCustomRoute | 查询自定义路由规则 ListCustomRoute |
| UpdateCustomRoute | 更新自定义路由规则 UpdateCustomRoute |