实例执行任务查询 - GetTask
功能介绍
实例执行任务批量查询。
调用此api的前提条件是租户需要先购买实例。
该接口需要和实例执行异步命令接口一起使用，使用实例执行异步命令接口返回的task_id作为路径上的参数以此获取异步命令执行的结果。
同时，该接口也可以和实例安装app接口一起使用，使用实例安装app接口返回的task_id作为路径上的参数，以此获取实例安装app的执行结果。
实例安装app接口返回的task_id有固定前缀“ZGCA”或者“FULFILL”，和实例执行异步命令接口返回的task_id有所区分。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
koophone:cloudphoneResource:queryExecuteJob
Read
cloudphoneResource *
-
-
-
URI
GET /v1/instances/tasks/{task_id}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
task_id | 是 | String | 异步请求返回的任务id |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
x-request-id | 是 | String | 消息跟踪唯一id |
X-Auth-Token | 是 | String | 租户级Token |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 响应码，错误码规范KooPhone.API.1001，数字递增 |
error_msg | String | 响应描述 |
data | JobDetailWrapper object | 根据task_id查询出的任务列表 |
参数 | 参数类型 | 描述 |
|---|---|---|
job_id | String | 任务唯一标识 |
status | Integer | 任务状态。1：运行中，2：成功，-1：失败 |
error_code | String | 任务错误码 |
error_msg | String | 任务错误码说明 |
execute_msg | String | 任务执行返回内容，最长1024字节。命令执行成功和失败均将命令的输出返回 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 0：成功 KOOPHONE.API.1323：app安装任务不存在 KOOPHONE.API.9999：服务内部错误 |
error_msg | String | 错误信息 |
状态码：500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 0：成功 KOOPHONE.API.1323：app安装任务不存在 KOOPHONE.API.9999：服务内部错误 |
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 | 内部错误 |
错误码
请参见错误码。
