本产品（
无影云手机/2023-09-30）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
实例组
| API | 标题 | API概述 |
|---|---|---|
| DescribeRegions | 查询可用地域 | 查询地域。 |
| DescribeSpec | 查询可用规格 | 查询云手机可用规格。 |
| CheckResourceStock | 检查资源库存状态 | 检查云手机资源库存状态。 |
| CreateAndroidInstanceGroup | 创建实例组 | 创建按量付费或包年包月的云手机实例组。 |
| DescribeAndroidInstanceGroups | 查询实例组详细信息 | 查询云手机实例组的详细信息。 |
| ModifyAndroidInstanceGroup | 修改实例组信息 | 修改云手机实例组的信息。 |
| UpgradeAndroidInstanceGroup | 升级实例组 | 升级实例组。目前仅支持增加实例组中的实例数量。 |
| DowngradeAndroidInstanceGroup | 降级实例组 | 降级实例组。目前仅支持删除实例组中的指定实例。 |
| RenewAndroidInstanceGroups | 续费实例组 | 续费云手机实例组。 |
| DeleteAndroidInstanceGroup | 删除实例组 | 删除云手机实例组。 |
实例
| API | 标题 | API概述 |
|---|---|---|
| DescribeAndroidInstances | 查询实例详细信息 | 查询云手机实例的详情信息。 |
| ModifyAndroidInstance | 修改实例信息 | 修改云手机实例信息。目前仅支持修改实例名称。 |
| AuthorizeAndroidInstance | 实例分配用户&取消分配 | 为云手机实例分配用户或者取消已分配用户。目前一台云手机实例仅支持分配一个用户。 |
| StartAndroidInstance | 启动实例 | 启动云手机实例。 |
| StopAndroidInstance | 停止实例 | 停止云手机实例。 |
| RebootAndroidInstancesInGroup | 重启实例 | 重启云手机实例。 |
| ResetAndroidInstancesInGroup | 重置实例（初始化系统） | 重置云手机实例，即初始化系统。 |
| 远程命令 | 远程命令 | |
| RunCommand | 执行命令 | 在云手机实例中执行命令。 |
| DescribeInvocations | 查询命令执行结果 | 查询RunCommand接口命令执行结果。 |
| 文件上传下载 | 文件上传下载 | |
| SendFile | 文件上传到云手机 | 调用SendFile接口将OSS文件推送到云手机。 |
| FetchFile | 从云手机拉取文件 | 调用Fetch接口云手机拉取文件到OSS。 |
镜像
| API | 标题 | API概述 |
|---|---|---|
| CreateCustomImage | 创建自定义镜像 | 根据云手机实例创建自定义镜像。 |
| DescribeImageList | 查询镜像列表 | 查询镜像列表。 |
| UpdateInstanceGroupImage | 变更实例组镜像 | 变更实例组镜像。 |
| UpdateCustomImageName | 更新自定义镜像名称 | 更新自定义镜像名称。 |
| DistributeImage | 分发镜像 | 分发镜像。 |
| DeleteImages | 删除自定义镜像 | 删除自定义镜像。 |
应用
| API | 标题 | API概述 |
|---|---|---|
| CreateApp | 创建应用 | 创建Android应用。 |
| DescribeApps | 查询应用信息 | 查询已经创建的应用信息。 |
| ModifyApp | 修改应用信息 | 修改应用信息。 |
| DeleteApps | 删除应用 | 删除应用。 删除时需保证该应用未安装在任何实例组。 |
| InstallApp | 安装应用 | 批量在无影云手机实例组的实例中安装应用。 此接口为异步接口，安装结果可以通过查询应用安装历史查看。 |
| UninstallApp | 卸载应用 | 批量从无影云手机实例组中卸载应用。卸载时需保证应用已经安装在云手机实例组中。 此接口为异步接口，卸载结果可以通过查询应用安装历史查看。 |
密钥
| API | 标题 | API概述 |
|---|---|---|
| SetAdbSecure | 设置ADB鉴权开关 | 设置实例的ADB鉴权状态。 如果设置ADB鉴权状态为开启，通过ADB去连接云手机实例时，云手机实例会校验ADB密钥对的合法性；此时建议您绑定ADB密钥对后，再通过ADB连接云手机实例。 如果设置ADB鉴权状态为关闭，通过ADB去连接云手机实例时，云手机实例不会校验ADB密钥对的合法性，即只要网络是通的，就能通过ADB连接上云手机实例。 |
| GetAdbSecure | 获取ADB鉴权开关 | 获取ADB鉴权开关。 如果ADB鉴权状态开启，尝试通过ADB去连接云手机实例时，云手机实例会校验ADB密钥对的合法性；此时建议您绑定ADB密钥对后，再通过ADB连接云手机实例。 如果ADB鉴权状态关闭，尝试通过ADB去连接云手机实例时，云手机实例不会校验ADB密钥对的合法性，即只要网络是通的，就能通过ADB连接上云手机实例。 |
| CreateKeyPair | 创建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 | 创建备份文件 | 调用BackupFile接口生成并上传备份文件。 |
| RecoveryFile | 恢复备份文件 | 调用RecoveryFile接口恢复备份文件。 |
| DescribeBackupFiles | 查询备份文件列表 | 调用DescribeBackupFiles接口查询备份文件列表。 |
策略
| API | 标题 | API概述 |
|---|---|---|
| CreatePolicyGroup | 创建策略 | 创建策略。 |
| ListPolicyGroups | 查询策略详细信息 | 查询策略的详细信息。 |
| ModifyPolicyGroup | 修改策略信息 | 修改策略。 |
| DeletePolicyGroup | 删除策略 | 删除策略。 |