
# API概览
云手机服务接口的分类与说明如[表1]所示。
 表1云手机服务接口说明 
| 类型                                                                                                            | 说明                                                                            |
|:---|:---|
| [实例执行同步命令 - SyncCommand](https://support.huaweicloud.com/api-koophone/SyncCommand.html)                       | 通过调用该接口可以对云机实例同步执行adb shell命令操作。                                              |
| [实例执行异步命令 - AsyncCommand](https://support.huaweicloud.com/api-koophone/AsyncCommand.html)                     | 通过调用该接口可以对云机实例异步执行adb shell命令操作。                                              |
| [实例执行任务查询 - GetTask](https://support.huaweicloud.com/api-koophone/GetTask.html)                               | 执行异步adb shell命令后，通过调用该接口查询执行结果。                                               |
| [实例视频设置 - SetVideoConfig](https://support.huaweicloud.com/api-koophone/SetVideoConfig.html)                   | 通过调用该接口可以设置实例每一个清晰度对应的码率和出流的帧率。                                               |
| [实例状态批量查询 - BatchQueryStatus](https://support.huaweicloud.com/api-koophone/BatchQueryStatus.html)             | 通过调用该接口可以查询云机实例状态。                                                            |
| [实例批量重置 - BatchReset](https://support.huaweicloud.com/api-koophone/BatchReset.html)                           | 通过调用该接口可以对云机实例进行重置操作。                                                         |
| [租户实例串流前获取设备的device_token - GetDeviceToken](https://support.huaweicloud.com/api-koophone/GetDeviceToken.html) | 通过调用该接口获取云机实例的device_token后作为鉴权信息，携带云机实例的device_id去调用反参中的信令地址（signaling_url）。 |
| [实例分配 - AssignInstance](https://support.huaweicloud.com/api-koophone/AssignInstance.html)                     | 通过调用该接口可以将云机分配给租户指定的用户。                                                       |
| [实例取消分配 - UnassignInstance](https://support.huaweicloud.com/api-koophone/UnassignInstance.html)               | 通过调用该接口可以将云机取消分配给租户指定的用户，调用后会清除用户云机使用数据。                                      |
| [实例批量查询 - ListInstances](https://support.huaweicloud.com/api-koophone/ListInstances.html)                     | 通过调用该接口可以批量查询租户下所有实例信息。                                                       |
| [应用列表查询 - ListInstanceApp](https://support.huaweicloud.com/api-koophone/ListInstanceApp.html)                 | 通过调用该接口可以查询实例安装应用列表。                                                          |
| [实例重启 - BatchRebootInstance](https://support.huaweicloud.com/api-koophone/BatchRebootInstance.html)           | 通过调用该接口可以批量重启云机实例。                                                            |
| [可售实例sku批量查询 - BatchShowSku](https://support.huaweicloud.com/api-koophone/BatchShowSku.html)                  | 通过调用该接口可以查询租户下所有可售实例的规格信息。                                                    |
| [实例开通接口 - CreateInstance](https://support.huaweicloud.com/api-koophone/CreateInstance.html)                   | 通过调用该接口可以生成实例。                                                                |
| [实例删除 - DeleteInstance](https://support.huaweicloud.com/api-koophone/DeleteInstance.html)                     | 通过调用该接口可以退订已经订购的包周期实例（按需的实例不支持退订）。                                            |
| [实例批量准备 - BatchPrepareInstances](https://support.huaweicloud.com/api-koophone/BatchPrepareInstances.html)     | 通过调用该接口，当前实例会被准备到可以串流的状态。                                                     |
| [实例准备进度 - ShowProgress](https://support.huaweicloud.com/api-koophone/ShowProgress.html)                       | 通过循环调用此接口直到云机状态为正常则可开启串流。                                                     |
| [实例备份 - BatchBackupInstances](https://support.huaweicloud.com/api-koophone/BatchBackupInstances.html)         | 通过调用该接口，实例数据批量备份到OBS，然后释放物理实例。                                                |
| [实例停止串流 - StopInstancesStreaming](https://support.huaweicloud.com/api-koophone/StopInstancesStreaming.html)   | 通过调用该接口可以停止实例串流，若不在串流中的实例则无效果。                                                |
| [实例释放会话 - ReleaseInstancesSession](https://support.huaweicloud.com/api-koophone/ReleaseInstancesSession.html) | 通过调用该接口，串流停止后会话还会存续一段时间，此接口可提供释放。                                             |
| [实例安装app - InstallApp](https://support.huaweicloud.com/api-koophone/InstallApp.html)                          | 通过调用该接口可以向云机实例批量安装app。                                                        |
   
