检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 实例管理 实例使用
API概览 云手机服务接口的分类与说明如表1所示。 表1 KooPhone接口说明 类型 说明 实例执行同步命令 通过该接口可以指定云机实例同步执行adb shell命令。 实例执行异步命令 通过该接口可以指定云机实例异步执行adb shell命令。
如何调用API 构造请求 认证鉴权 返回结果
充值:客户通过在线支付、转账汇款等支付方式向华为云账户增加金额的过程。 续费:客户通过在线支付、转账汇款等支付方式延长已购买产品的使用权限。 父主题: KooPhone购买与计费
实例使用 租户实例串流前获取设备的device_token 父主题: API
实例管理 实例执行同步命令 实例执行异步命令 实例执行任务批量查询 实例视频设置 实例状态批量查询 实例批量重置 父主题: API
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。
对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用接口时,请求body中auth.scope的取值需要选择project,如下所示。
实例批量重置 功能介绍 实例批量重置, 调用此api的前提条件是租户需要先购买koophone云手机实例。 调用该接口后,当前实例会被初始化。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。
调用此api的前提条件是租户需要先购买koophone云手机实例。 使用该接口可以设置实例每一个清晰度对应的码率和出流的帧率。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。
调用此api的前提条件是租户需要先购买koophone云手机实例。 接口返回实例当前的状态:云机状态,0:未知,1: 已停止,2:运行中,3:下线中,4:启动中, 5:已关机。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。
实例执行异步命令 功能介绍 实例执行异步命令接口。 调用此api的前提条件是租户需要先购买koophone云手机实例。 可以通过调用该接口实现对自己的koophone云手机实例进行异步adb指令操作。 调用完该接口后携带该接口返回的task_id去调用实例执行任务查询接口。
实例执行同步命令 功能介绍 实例执行同步命令接口。调用此api的前提条件是租户需要先购买koophone云手机实例。可以通过调用该接口实现对自己的koophone云手机实例进行adb指令操作。 该接口是同步操作接口,如果有耗时adb操作建议使用实例执行异步命令接口。
调用此api的前提条件是租户需要先购买koophone云手机实例。 该接口需要和实例执行异步命令接口一起使用,使用实例执行异步命令接口返回的task_id作为路径上的参数以此获取异步命令执行的结果。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。
调用该接口获取云机实例的device_token后作为鉴权信息,并携带云机实例的device_id去调用反参中的信令地址(signaling_url)。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。
附录 状态码 错误码 获取项目ID
您可以使用本文档提供的API对云手机服务进行相关操作。如视频设置、批量重置等。支持的全部操作请参见API概览。 在调用云手机服务API之前,请确保已经充分了解云手机服务相关概念。详细信息请参见云手机服务的《产品介绍》。
状态码 错误码 错误信息 描述 处理措施 400 KOOPHONE.API.1000 请求参数错误 请求参数错误 检查请求参数类型及范围是否满足接口定义 400 KOOPHONE.API.1002 实例非同一个大区 实例非同一个大区 修改请求实例为同一个大区 401 KOOPHONE.API
429 Too Many Requests 服务器会对接口进行流控,超过了接口限流要求,服务器将无法处理。 500 Internal Server Error 服务器遇到了一个未曾预料的状况,导致了它无法完成对请求的处理。