文档首页/ 云手机服务 KooPhone/ API参考/ API/ 实例管理/ 实例执行同步命令
更新时间：2024-04-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

实例执行同步命令

功能介绍

实例执行同步命令接口。调用此api的前提条件是租户需要先购买koophone云手机实例。可以通过调用该接口实现对自己的koophone云手机实例进行adb指令操作。 该接口是同步操作接口，如果有耗时adb操作建议使用实例执行异步命令接口。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/instances/sync-command

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

x-request-id

是

String

消息跟踪唯一id

X-Auth-Token

是

String

租户级Token
表2 请求Body参数

参数

是否必选

参数类型

描述

command

是

String

命令，最大长度为1024字节，只支持大小写字母、数字、下划线（_）、点（.）、斜线（/）、冒号（:）、中划线（-）。

最大长度：1024

instance_ids

是

Array of strings

实例列表

最大长度：32

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

error_code

String

响应码，错误码规范KP.API.0001，数字递增

error_msg

String

响应描述

data

CmdResultWrapper object

命令执行结果
表4 CmdResultWrapper

参数

参数类型

描述

cmd_results

Array of CmdResult objects

命令执行结果
表5 CmdResult

参数

参数类型

描述

instance_id

String

实例id

最大长度：32

status

Integer

任务状态。1表示运行中，2表示成功，-1表示失败

error_code

String

任务错误码

error_msg

String

任务错误码说明

execute_msg

String

任务执行返回内容，最长1024字节。命令执行成功和失败均将命令的输出返回

最大长度：1024

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

响应码，错误码规范KOOPHONE.API.0001，数字递增 error_code为0时表示成功

error_msg

String

响应描述

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

响应码，错误码规范KOOPHONE.API.0001，数字递增 error_code为0时表示成功

error_msg

String

响应描述

请求示例

/v1/instances/sync-command 

{
  "command" : "ls -l /system",
  "instance_ids" : [ "a44uhlf7", "efjy72gs" ]
}

响应示例

状态码： 200

正常响应

{
  "data" : {
    "cmd_results" : [ {
      "instance_id" : "a44uhlf7",
      "status" : -1,
      "error_code" : "CPS.0191",
      "error_msg" : "Run command failed.",
      "execute_msg" : "ls: cannot access '/system': No such file or directory"
    }, {
      "instance_id" : "efjy72gs",
      "status" : 2,
      "error_code" : "",
      "error_msg" : "",
      "execute_msg" : "xxxxxx"
    } ]
  },
  "error_code" : "0",
  "error_msg" : "ok"
}

状态码

状态码

描述

200

正常响应

400

请求错误

500

内部错误

错误码

请参见错误码。

父主题： 实例管理

相关文档