You need to enable JavaScript to run this app.
导航
OpenAPI 概览
最近更新时间:2024.05.13 21:05:23首次发布时间:2021.10.18 18:27:22

云手机结合了云计算和超低延迟的音视频传输技术,通过跨终端虚拟云服务,为客户提供流畅、实时、高效的分布式云计算与边缘计算服务。

我们开放了云手机-iPaaS相关业务的 OpenAPI。本文档为您提供具体的 API 描述、语法、参数说明及示例等,您可以调用 API 管理云手机服务资源。

接口列表

云机相关接口

云机指代提供云手机 iPaaS 服务的物理服务器。云机管理相关的接口如下:

接口名称
接口功能
CreateDevices在指定业务下,订购云机资源
DeleteDevices在指定业务下,退订云机资源
ListHost获取指定业务内已购买的云机信息
RebootHost对指定云机执行重启操作

实例相关接口

实例主要指代云机提供的资源实例(pod),是资源使用的最小单位。实例相关的接口如下:

接口名称
接口功能
ListInstance获取指定业务内实例的详细信息
DetailInstance获取指定实例的详细信息
PowerUpInstance对指定实例上电开机
PowerDownInstance对指定实例下电关机
WarmRebootInstance热重启指定实例
ColdRebootInstance冷重启指定实例
ListInstanceMetricData查询指定实例在某段时间内的监控指标
GetInstanceProperty查询云手机实例属性
UpdateInstanceProperty更新云手机实例属性
SetInstanceProperties单实例批量设置属性(同步)
GetInstanceProperties单实例批量获取属性(同步)
ModifyInstanceWindowDisplaySpec修改指定云手机实例的屏幕分辨率
ModifyInstanceFps修改指定云手机实例的帧率
SetInstanceBandwidth修改指定云手机实例的带宽峰值
ResetInstanceToFactory重置云手机实例(恢复出厂设置)
ResetInstances重置云手机实例的镜像
UpgradeInstances升级指定云手机实例的镜像
ListPortMapping获取指定实例的源端口和目标端口的映射关系

实例操控相关接口

实例操控相关接口如下:

接口名称
接口功能
AdbCommand对多个云手机实例执行命令(异步)
ExecCmdSync对指定云手机实例执行命令(同步)
PushFile推送文件到云手机实例(异步)
PullFile从指定云手机实例下载文件到对象存储(异步)
RecordScreen对指定云手机实例录屏,并保存录制文件
InstallApplication安装应用到云手机实例(异步)
ControlApplication管理已安装的应用(包含卸载、启用、停用、启动、停止,异步)

文件分发相关接口

文件分发相关接口如下:

接口名称
接口功能
DistributeFile分发文件到单实例(异步)
DistributeFileToInstances分发文件到多实例(异步)
GetFileDistributionResult查询文件分发任务执行结果
GetFileDistributionJobDetail查询批量文件分发任务执行的详情

安全组相关接口

安全组为云机配置端口映射规则,可与多个云机实例相关联绑定。安全组相关接口如下:

接口名称
接口功能
ListSecurityGroup获取指定业务内已创建的安全组
DetailSecurityGroup获取指定安全组的详细信息
BindInstancesSecurityGroup将多个实例与指定安全组绑定
UnbindInstancesSecurityGroup批量解除多个实例已绑定的安全组
FixInstancesSGBound实例入向访问规则下发重试

密钥对相关接口

密钥对为用户远程登陆云机提供认证方式,可与多个云机实例相关联绑定。密钥对相关接口如下:

接口名称
接口功能
ListAdbKey获取指定业务内已创建的密钥对
BindInstanceAdbKey将实例与指定的密钥对绑定
BindInstancesAdbKey将多个实例与指定密钥对绑定
UnbindInstanceAdbKey解除指定实例已绑定的密钥对
UnbindInstancesAdbKey批量解除多个实例已绑定的密钥对

任务查询接口

任务执行结果查询接口如下:

接口名称
接口功能
GetJobDetails查询异步任务执行结果

镜像管理相关接口

镜像是云机实例运行的所需的 Android 系统版本。镜像管理相关接口如下:

接口名称
接口功能
ImportContainerImage导入基于平台镜像基线改制的自定义镜像文件,构建成自定义镜像
ListContainerImages查询业务下可以使用的自定义镜像列表信息
UpdateContainerImage更新指定自定义镜像的信息,包括镜像名称和镜像备注信息
DeleteContainerImages删除指定自定义镜像

Token 获取相关接口

Token 用于对订购和退订云机等操作进行幂等校验。Token 获取相关接口如下:

接口名称
接口功能
AcquireIdempotentToken获取幂等 Token