本产品（eds-aic/2023-09-30）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
云手机矩阵
|
API |
标题 |
API概述 |
| CreateCloudPhoneNode | 创建云手机矩阵 | 创建云手机矩阵。 在无影云手机系统中，矩阵（Cloud Phone Server）是一个逻辑上的资源管理单元，代表一个物理服务器实例。该物理服务器可以被划分为多个独立运行的云手机实例，这些实例共享矩阵底层的计算、存储和网络资源。创建一个矩阵，即相当于获得一台物理服务器，您可以在其上创建相应的云手机实例（配置不同对应的云手机数量不同）。 |
| DescribeCloudPhoneNodes | 查询云手机矩阵信息 | 查询云手机矩阵的详细信息。 在无影云手机系统中，矩阵（Cloud Phone Server）是一个逻辑上的资源管理单元，代表一个物理服务器实例。该物理服务器可以被划分为多个独立运行的云手机实例，这些实例共享矩阵底层的计算、存储和网络资源。创建一个矩阵，即相当于获得一台物理服务器，您可以在其上创建相应的云手机实例（配置不同对应可创建的云手机数量不同）。 |
| ModifyCloudPhoneNode | 修改云手机矩阵信息 | 修改云手机矩阵信息。 在无影云手机系统中，矩阵（Cloud Phone Server）是一个逻辑上的资源管理单元，代表一个物理服务器实例。该物理服务器可以被划分为多个独立运行的云手机实例，这些实例共享矩阵底层的计算、存储和网络资源。创建一个矩阵，即相当于获得一台物理服务器，您可以在其上创建相应的云手机实例（配置不同对应的云手机数量不同）。 |
| RenewCloudPhoneNodes | 续费云手机矩阵 | 续费云手机矩阵。 |
| ChangeCloudPhoneNode | 变更云手机矩阵配置 | 变更云手机矩阵的配置，目前仅支持变更实例规格和云手机实例开数（实例开数即云手机矩阵的实例数量）。 |
| ExpandDataVolume | 扩容云手机矩阵存储 | 扩容云手机矩阵存储。可以对共享机身存储（用于存储镜像等矩阵级文件）、独立机身存储进行扩容。存储空间扩容后将产生新的费用，接口调用的响应参数中包含了新费用的订单ID。 |
| DeleteCloudPhoneNodes | 删除云手机矩阵 | 删除云手机矩阵。 |
实例组
|
API |
标题 |
API概述 |
| DescribeRegions | 查询可用地域 | 查询地域。 |
| DescribeSpec | 查询可用规格 | 查询云手机可用规格。 实例的创建需要指定规格参数，可通过该接口获取所有规格信息。对于矩阵创建的情况，可以通过该接口获取矩阵的最大和最小开数限制（单个矩阵创建实例数的限制）。 |
| CheckResourceStock | 检查资源库存状态 | 检查云手机资源库存状态。在实例创建前，可先通过该接口检测目标region库存是否足够，确认足够后再进行创建。 |
| CreateAndroidInstanceGroup | 创建实例组 | 创建按量付费或包年包月的云手机实例组。一个实例组可以管理多个实例。可以将具有相同功能定位的实例编入同一个实例组，以便于统一管理。 |
| DescribeAndroidInstanceGroups | 查询实例组详细信息 | 查询云手机实例组的详细信息。 |
| ModifyAndroidInstanceGroup | 修改实例组信息 | 修改云手机实例组的信息。 |
| UpgradeAndroidInstanceGroup | 升级实例组 | 升级实例组。目前仅支持增加实例组中的实例数量，即实例组扩容。 |
| DowngradeAndroidInstanceGroup | 降级实例组 | 降级实例组。目前仅支持释放实例组中的指定实例。 |
| RenewAndroidInstanceGroups | 续费实例组 | 续费云手机实例组。预付费（包年包月）已到期 15天系统将自动删除实例组及其实例，且不可恢复，请及时进行续费操作。 |
| UpdateInstanceGroupImage | 变更实例组镜像 | 变更实例组镜像。会作用于该实例组下的所有实例。 |
| DeleteAndroidInstanceGroup | 删除实例组 | 删除云手机实例组。 将同步删除实例组下的所有实例，删除后不可恢复，请谨慎操作。 |
实例
|
API |
标题 |
API概述 |
| DescribeAndroidInstances | 查询实例详细信息 | 查询云手机实例的详情信息。 |
| ModifyAndroidInstance | 修改实例信息 | 修改云手机实例信息。目前仅支持修改实例名称、上下行带宽限制。 |
| AuthorizeAndroidInstance | 实例分配用户&取消分配 | 为云手机实例分配用户或者取消已分配用户。目前一台云手机实例仅支持分配一个用户。 |
| StartAndroidInstance | 启动实例 | 启动（开机）云手机实例。 |
| StopAndroidInstance | 停止实例 | 停止（关机）云手机实例。 |
| RebootAndroidInstancesInGroup | 重启实例 | 重启（先关机再开机）云手机实例。 |
| ResetAndroidInstancesInGroup | 重置实例（初始化系统） | 重置云手机实例。 重置是使用该云手机的镜像进行重装系统的过程，如云手机创建时使用的镜像被删除将重置失败。 |
| ModifyInstanceChargeType | 修改实例的付费方式 | 修改实例的付费方式。目前只支持按量付费转为包年包月。 |
| UpdateInstanceImage | 变更实例镜像 | 变更云手机矩阵实例镜像。仅支持对运行中、关机、镜像变更失败这三种状态的实例进行镜像变更。目标镜像的GPU厂商必须与当前实例所在的服务器GPU厂商匹配。如果是跨版本变更镜像，例如从Android 10升级到Android 12，则系统将强制清空所有数据（等同于变更镜像+重置）。 |
| 连接&断连 | 连接&断连 | |
| BatchGetAcpConnectionTicket | 批量获取实例连接凭证 | 批量获取连接凭证。本接口会异步进行Ticket的生成，绝大多数可第一次直接从Response中直接拿到Ticket，部分情况需要根据Response中的TaskId再调用本接口进行轮询是否生成。 |
| DisconnectAndroidInstance | 断开实例的连接 | 将处于连接中的实例断开连接，或将被其他用户绑定的实例解绑。 |
| 远程命令 | 远程命令 | |
| RunCommand | 执行命令 | 在云手机实例中执行命令。 |
| DescribeInvocations | 查询命令执行结果 | 查询RunCommand接口命令执行结果。 |
| 文件上传下载 | 文件上传下载 | |
| SendFile | 文件上传到云手机 | 将OSS文件或者公网下载链接的文件推送到云手机。 |
| FetchFile | 从云手机拉取文件 | 从云手机拉取文件到OSS。 |
| 截屏 | 截屏 | |
| CreateScreenshot | 生成一张云手机的截屏图片 | 生成一张云手机的截屏图片，异步接口。 |
| 流协同 | 流协同 | |
| GenerateCoordinationCode | 生成协同码 | 云手机默认情况只能通过BatchGetAcpConnectionTicket接口获取连接Ticket，一个云手机只支持一个用户连接。如果需要多个用户连接同一个云手机。可为当前无影便捷账号连接中的云手机生成一个协同码，通过将协同码分享给其他便捷账号，则可实现其他账号连接到当前云手机的场景。 |
| EndCoordination | 结束协同 | 云手机所有者主动结束当前云手机实例的所有协同任务，协同码将同步失效。 |
镜像
|
API |
标题 |
API概述 |
| CreateCustomImage | 创建自定义镜像 | 根据云手机实例创建自定义镜像。可以进一步通过自定义镜像创建更多相同配置的云手机。 |
| DescribeImageList | 查询镜像列表 | 查询镜像列表。 |
| UpdateCustomImageName | 更新自定义镜像名称 | 更新自定义镜像名称。 |
| DistributeImage | 分发镜像 | 分发镜像。如需要在更多的地域使用此镜像，可使用分发镜像功能，将镜像文件传输到各个地域，支撑各地域根据该镜像创建云手机的需求。 |
| DeleteImages | 删除自定义镜像 | 删除自定义镜像。 |
应用
|
API |
标题 |
API概述 |
| CreateApp | 创建应用 | 创建Android应用。在进行应用安装前，必须先使用本接口进行应用创建。应用创建时不会进行应用下载，安装时才会进行下载操作，须确保云手机与下载URL的网络可达性。 |
| DescribeApps | 查询应用信息 | 查询已经创建的应用信息。 |
| ModifyApp | 修改应用信息 | 修改应用信息。 |
| DeleteApps | 删除应用 | 删除应用。 删除时需保证该应用未安装在任何实例组。 |
| InstallApp | 安装应用 | 批量在无影云手机实例中安装应用。 |
| UninstallApp | 卸载应用 | 批量从无影云手机实例中卸载应用。 |
| OperateApp | 操作应用 | 操作云手机内应用，支持打开、关闭、重启应用。 |
密钥
|
API |
标题 |
API概述 |
| CreateKeyPair | 创建ADB密钥对 | 用户可以通过ADB连接云手机，对云手机进行设备管理、应用管理、文件传输等操作。由于其操作权限较大且云手机没有物理接口，无法通过 USB 触发设备端的授权对话框。因此adb通过网络连接云手机，必须预先配置密钥对，让设备信任客户端，确保操作的安全。调用本接口CreateKeyPair可创建一对ADB密钥对。系统会为您保管密钥的公钥部分，并返回符合ADB连接规范的PEM编码的PKCS#8格式私钥。您需要自行妥善保管私钥部分。 |
| ImportKeyPair | 导入ADB密钥对 | 导入由ADB工具产生的ADB密钥对的公钥部分。 |
| DescribeKeyPairs | 查询ADB密钥对 | 查询一个或多个密钥对。 |
| ModifyKeyPairName | 修改ADB密钥对名称 | 调用本接口修改ADB密钥对的名称。 |
| DeleteKeyPairs | 删除ADB密钥对 | 调用本接口删除云手机密钥对。 |
| AttachKeyPair | 绑定ADB密钥对 | 调用AttachKeyPair绑定一个ADB密钥对到一台或多台云手机实例。 |
| DetachKeyPair | 解绑ADB密钥对 | 调用本接口解除ADB密钥对到一台或多台云手机实例的绑定关系。 |
备份
|
API |
标题 |
API概述 |
| BackupFile | 创建备份文件 | 生成备份文件并上传到远端存储。 使用场景：可以基于数据安全的角度进行定期备份，也可以备份一机文件，恢复到多机，实现类似复制迁移的效果。 |
| RecoveryFile | 恢复备份文件 | 恢复备份文件。 |
| DescribeBackupFiles | 查询备份文件列表 | 查询备份文件列表。 |
| DeleteBackupFile | 删除备份文件 | 批量删除备份文件。 |
策略
|
API |
标题 |
API概述 |
| CreatePolicyGroup | 创建策略 | 创建策略。策略用于对云手机进行统一的设置，如网络重定向策略、水印、分辨率、剪贴板等功能设置。 |
| ListPolicyGroups | 查询策略详细信息 | 查询策略的详细信息。 |
| ModifyPolicyGroup | 修改策略信息 | 修改策略。 |
| DeletePolicyGroup | 删除策略 | 删除策略。 |
系统属性模板
|
API |
标题 |
API概述 |
| CreateSystemPropertyTemplate | 创建系统属性模板 | 创建系统属性模板。属性模板中定义的属性键值对，将下发到云手机并通过setprop命令设置到云手机android系统中，APK或相关程序可读取这些属性值。 |
| SendSystemPropertyTemplate | 下发系统属性模板 | 发送属性模板。将下发到云手机并通过setprop命令设置到云手机android系统中，APK或相关程序可读取这些属性值。如果指定了多个模板ID，则随机组合属性模板和云手机实例。 |
| DescribeSystemPropertyTemplates | 查询系统属性模板 | 查询系统属性模板。 |
| GetInstanceProperties | 获取实例属性 | 获取实例属性信息。系统将通过android getprop命令获取所有云手机属性信息。 |
| ModifySystemPropertyTemplate | 修改系统属性模板 | 修改属性模板。 |
| DeleteSystemPropertyTemplates | 删除系统属性模板 | 删除系统属性模板。 |
任务
|
API |
标题 |
API概述 |
| DescribeTasks | 查询任务 | 获取云手机实例当前任务列表。云手机很多（创建、开关机等）的操作都是异步进行，系统将产生一个任务ID供用户查询操作进度及结果。用户可通过调用该接口查询所有任务清单及执行情况。 |
监控
|
API |
标题 |
API概述 |
| DescribeMetricLast | 查询指定云机的最新监控数据 | 查询实例或矩阵的最新监控数据。支持CPU、内存、磁盘、网络等监控数据的查询。 |
| InstallMonitorAgent | 安装监控插件 | 一键安装监控插件，只有安装了监控插件，实例才会有监控数据。 |
| UninstallMonitorAgent | 卸载监控插件 | 卸载监控插件。 |
标签
|
API |
标题 |
API概述 |
| TagResources | 为云手机添加标签 | 给云手机打标签。 |
| UntagResources | 为云手机移除标签 | 为云手机移除标签。移除标签后，如果该标签没有被添加到任何云手机上，则标签会被自动删除。 |
| ListTagResources | 查询云手机已添加标签的列表 | 查询云手机已添加的标签的列表。 |
其他
|
API |
标题 |
API概述 |
| SetAdbSecure | 设置ADB鉴权开关 | 设置实例的ADB鉴权状态。 如果设置ADB鉴权状态为开启，通过ADB去连接云手机实例时，云手机实例会校验ADB密钥对的合法性；此时建议您绑定ADB密钥对后，再通过ADB连接云手机实例。 如果设置ADB鉴权状态为关闭，通过ADB去连接云手机实例时，云手机实例不会校验ADB密钥对的合法性，即只要网络是通的，就能通过ADB连接上云手机实例。 |
| ModifyDisplayConfig | 修改显示设置 | 修改显示设置。 |
| DescribeDisplayConfig | 查询显示设置 | 查询显示设置。 |
该文章对您有帮助吗？