检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 实例管理 实例使用
API概览 云手机服务接口的分类与说明如表1所示。 表1 KooPhone接口说明 类型 说明 实例执行同步命令 通过该接口可以指定云机实例同步执行adb shell命令。 实例执行异步命令 通过该接口可以指定云机实例异步执行adb shell命令。 实例执行任务查询 执行异步adb
如何调用API 构造请求 认证鉴权 返回结果
参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需
实例使用 租户实例串流前获取设备的device_token 父主题： API
实例管理 实例执行同步命令 实例执行异步命令 实例执行任务批量查询 实例视频设置 实例状态批量查询 实例批量重置 父主题： API
完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 对于获取用户Token接口，返回如图1所示的消息头，其中“x-subject-tok
就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用接口时，请求body中auth.scope的取值需要选择project，如下所示。
实例批量重置 功能介绍 实例批量重置， 调用此api的前提条件是租户需要先购买koophone云手机实例。 调用该接口后，当前实例会被初始化。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
实例视频设置 功能介绍 实例视频设置。 调用此api的前提条件是租户需要先购买koophone云手机实例。 使用该接口可以设置实例每一个清晰度对应的码率和出流的帧率。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
实例状态批量查询。 调用此api的前提条件是租户需要先购买koophone云手机实例。 接口返回实例当前的状态：云机状态，0：未知，1： 已停止，2：运行中，3：下线中，4：启动中， 5：已关机。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explore
实例执行异步命令接口。 调用此api的前提条件是租户需要先购买koophone云手机实例。 可以通过调用该接口实现对自己的koophone云手机实例进行异步adb指令操作。 调用完该接口后携带该接口返回的task_id去调用实例执行任务查询接口。 调试 您可以在API Explor
功能介绍 实例执行同步命令接口。调用此api的前提条件是租户需要先购买koophone云手机实例。可以通过调用该接口实现对自己的koophone云手机实例进行adb指令操作。 该接口是同步操作接口，如果有耗时adb操作建议使用实例执行异步命令接口。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API
实例执行任务批量查询。 调用此api的前提条件是租户需要先购买koophone云手机实例。 该接口需要和实例执行异步命令接口一起使用，使用实例执行异步命令接口返回的task_id作为路径上的参数以此获取异步命令执行的结果。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API
调用此api的前提条件是租户需要先购买koophone云手机实例。 调用该接口获取云机实例的device_token后作为鉴权信息，并携带云机实例的device_id去调用反参中的信令地址（signaling_url）。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API
附录 状态码 错误码 获取项目ID
和云OS的丰富应用，提供优成本、丰富应用生态和优致用户体验。 您可以使用本文档提供的API对云手机服务进行相关操作。如视频设置、批量重置等。支持的全部操作请参见API概览。 在调用云手机服务API之前，请确保已经充分了解云手机服务相关概念。详细信息请参见云手机服务的《产品介绍》。
当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KOOPHONE.API.1000 请求参数错误 请求参数错误 检查请求参数类型及范围是否满足接口定义 400 KOOPHONE.API.1002
又没有定义 If-Range 请求头，那么服务器就应当返回416状态码。 429 Too Many Requests 服务器会对接口进行流控，超过了接口限流要求，服务器将无法处理。 500 Internal Server Error 服务器遇到了一个未曾预料的状况，导致了它无法完成对请求的处理。
获取项目ID 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。项目ID获取步骤如下： 登录华为云管理控制台。 鼠标悬停在右上角的用户名，选择下拉列表中的“我的凭证”。 在“API凭证”页面的项目列表中查看项目ID。 图1 查看项目ID 父主题： 附录
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
