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

实例执行任务批量查询

功能介绍

实例执行任务批量查询。 调用此api的前提条件是租户需要先购买koophone云手机实例。 该接口需要和实例执行异步命令接口一起使用，使用实例执行异步命令接口返回的task_id作为路径上的参数以此获取异步命令执行的结果。

调试

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

URI

GET /v1/instances/tasks/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

异步请求返回的任务id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-request-id

是

String

消息跟踪唯一id

X-Auth-Token

是

String

租户级Token

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

error_code

String

响应码，错误码规范KooPhone.API.1001，数字递增

error_msg

String

响应描述

data

JobDetailWrapper object

根据task_id查询出的任务列表
表4 JobDetailWrapper

参数

参数类型

描述

jobs

Array of JobDetail objects

根据task_id查询出的任务列表
表5 JobDetail

参数

参数类型

描述

job_id

String

任务唯一标识

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/tasks/6837531fd3f54550927b930180a706bf

响应示例

状态码： 200

正常响应

{
  "data" : {
    "jobs" : [ {
      "job_id" : "1564567b8bab40f34711234cb80d0123",
      "status" : -1,
      "error_code" : "CPS0005",
      "error_msg" : "Phone not found.",
      "execute_msg" : null
    }, {
      "job_id" : "1564567b8bab40f34711234cb80d0456",
      "status" : 2,
      "error_code" : "",
      "error_msg" : "",
      "execute_msg" : "xxxxxx"
    } ]
  },
  "error_code" : "0",
  "error_msg" : "ok"
}

状态码

状态码

描述

200

正常响应

400

请求错误

500

内部错误

错误码

请参见错误码。

父主题： 实例管理

相关文档