链接复制成功!
实例执行异步命令
功能介绍
实例执行异步命令接口。
调用此api的前提条件是租户需要先购买koophone云手机实例。
可以通过调用该接口实现对自己的koophone云手机实例进行异步adb指令操作。
调用完该接口后携带该接口返回的task_id去调用实例执行任务查询接口。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/instances/async-command
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
x-request-id |
是 |
String |
消息跟踪唯一id |
X-Auth-Token |
是 |
String |
租户级Token |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
command |
是 |
String |
命令,最大长度为1024字节,只支持大小写字母、数字、下划线(_)、点(.)、斜线(/)、冒号(:)、中划线(-)。 |
instance_ids |
是 |
Array of strings |
实例列表 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码,错误码规范KooPhone.API.1001,数字递增 |
error_msg |
String |
响应描述 |
data |
InstanceAsyncCommandsInfo object |
响应内容 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码,KOOPHONE.API.xxxx或者common.00000xxx |
error_msg |
String |
响应描述 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码,KOOPHONE.API.xxxx或者common.00000xxx |
error_msg |
String |
响应描述 |
请求示例
/v1/instances/async-command
{
"command" : "ls -l /system",
"instance_ids" : [ "a44uhlf7", "efjy72gs" ]
}
响应示例
状态码:200
正常响应
{
"data" : {
"task_id" : "6837531fd3f54550927b930180a706bf",
"cmd_jobs" : [ {
"instance_id" : "a44uhlf7",
"job_id" : "1564567b8bab40f34711234cb80d0123"
}, {
"instance_id" : "efjy72gs",
"job_id" : "1564567b8bab40f34711234cb80d0456"
} ]
},
"error_code" : "0",
"error_msg" : "ok"
}
状态码
状态码 |
描述 |
---|---|
200 |
正常响应 |
400 |
请求错误 |
500 |
内部错误 |
错误码
请参见错误码。