本產品（
無影云手機/2023-09-30）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用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 | 重置實例（初始化系統） | 重置云手機實例，即初始化系統。 |
| BatchGetAcpConnectionTicket | 批量獲取實例連接憑證 | 批量獲取連接憑證 |
| 遠程命令 | 遠程命令 | |
| RunCommand | 執行命令 | 在云手機實例中執行命令。 |
| DescribeInvocations | 查詢命令執行結果 | 查詢RunCommand接口命令執行結果。 |
| 文件上傳下載 | 文件上傳下載 | |
| SendFile | 文件上傳到云手機 | 將OSS文件推送到云手機。 |
| FetchFile | 從云手機拉取文件 | 調用Fetch接口云手機拉取文件到OSS。 |
鏡像
| API | 標題 | API概述 |
|---|---|---|
| CreateCustomImage | 創建自定義鏡像 | 根據云手機實例創建自定義鏡像。 |
| DescribeImageList | 查詢鏡像列表 | 查詢鏡像列表。 |
| UpdateInstanceGroupImage | 變更實例組鏡像 | 變更實例組鏡像。 |
| UpdateCustomImageName | 更新自定義鏡像名稱 | 更新自定義鏡像名稱。 |
| DistributeImage | 分發鏡像 | 分發鏡像。 |
| DeleteImages | 刪除自定義鏡像 | 刪除自定義鏡像。 |
應用
| API | 標題 | API概述 |
|---|---|---|
| CreateApp | 創建應用 | 創建Android應用。 |
| DescribeApps | 查詢應用信息 | 查詢已經創建的應用信息。 |
| ModifyApp | 修改應用信息 | 修改應用信息。 |
| DeleteApps | 刪除應用 | 刪除應用。 刪除時需保證該應用未安裝在任何實例組。 |
| InstallApp | 安裝應用 | 批量在無影云手機實例組的實例中安裝應用。 此接口為異步接口，安裝結果可以通過查詢應用安裝歷史查看。 |
| UninstallApp | 卸載應用 | 批量從無影云手機實例組中卸載應用。卸載時需保證應用已經安裝在云手機實例組中。 此接口為異步接口，卸載結果可以通過查詢應用安裝歷史查看。 |
| OperateApp | 操作應用 | 操作云手機內應用，支持打開、關閉、重啟應用。 |
密鑰
| API | 標題 | API概述 |
|---|---|---|
| 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 | 創建備份文件 | 生成并上傳備份文件。 |
| RecoveryFile | 恢復備份文件 | 調用RecoveryFile接口恢復備份文件。 |
| DescribeBackupFiles | 查詢備份文件列表 | 調用DescribeBackupFiles接口查詢備份文件列表。 |
策略
| API | 標題 | API概述 |
|---|---|---|
| CreatePolicyGroup | 創建策略 | 創建策略。 |
| ListPolicyGroups | 查詢策略詳細信息 | 查詢策略的詳細信息。 |
| ModifyPolicyGroup | 修改策略信息 | 修改策略。 |
| DeletePolicyGroup | 刪除策略 | 刪除策略。 |
任務
| API | 標題 | API概述 |
|---|---|---|
| DescribeTasks | 查詢任務 | 獲取云手機實例當前任務列表。 |