作用:查询任务详细信息
路径:/rpa/openapi/raas/task/ListTaskDetails
类型:GET
使用方式:
无特殊说明
使用限制:
接口调用限制详见调用限制。
请求参数:
名称 | 类型 | 是否必选 | 示例值 | 描述 |
TaskIds | Array of String,序列化方式:simple | 是 | ["3226a05a -****-****-****- b8fb7e4561c6", "092fb04a -****-****-****- 6c0301a3b066"] | 任务ID列表。一次调用最多可输入10个任务id,超过请自行分批多次调用 |
返回参数:
返回参数公共字段请查阅返回结果,返回参数中的 data 字段说明如下:
名称 | 类型 | 示例值 | 描述 |
TaskId | String | ca9be99c -****-****-****- ee6a1f67cb68 | 任务ID |
TaskStatus | String | complete | 任务状态 |
TaskStatusLatestUpdateTime | String | 2022-05-16 21:07:03 | 任务状态最新更新时间 |
TaskBeginTime | String | 2022-05-16 20:00:00 | 任务开始时间 |
TaskEndTime | String | 2022-05-16 21:07:03 | 任务结束时间 |
AllocateMode | String | manu | 任务分配方式 |
TaskPriority | Integer | 50 | 任务优先级 |
AppId | String | de6f8980 -****-****-****- 3b0090c2d12f | 应用ID |
AppParams | Array of Json | [{"name":"参数1","value":""},{"name":"参数2","value":""}] | 创建任务时的应用入参 |
TaskResult | String | 示例结果 | 用法和限制详见task_result |
RobotId | String | 11DC8 ****** 1A4E463B1E538436035653 | 机器人ID |
PackId | String | bv2XPrDl | 机器人分组ID |
CallbackUrl | String | http://example.callback.com | 创建任务时指定的回调地址 |
TaskErrorInfo | Object,Object序列化方式:Json | { "Source": "client", "Description": "等待控件超时", "Operator": { "Id": "exampleUserId", "Name": "exampleUserName" }, "StatusCode": { "Code": "0000", "Value": "terminatedUnexpected" } } | 任务执行失败情况下对异常任务的描述,任务正常结束时该字段为null。其中各个字段介绍详见下表。 |
TaskErrorInfo内各字段详情:
名称 | 类型 | 示例值 | 描述 |
Source | String | api | 操作来源,表示任务异常结束的发起方。枚举值有:console、api、client |
Description | String | 任务被手动终止 | 异常结束的简短详情描述 |
Operator | Object,Object序列化方式:Json | { "Id": "exampleUserId", "Name": "exampleUserName" } | 操作人相关信息,其中Id为用户id、Name为用户名,两个字段均为String类型 |
StatusCode | Object,Object序列化方式:Json | { "Code": "4000", "Value": "raas.task.terminatedManually" } | 任务状态码,两个字段均为String类型。枚举如下: 0000:缺省值,表示异常结束 3001:任务从控制台被停止 3002:任务所在分组从控制台被删除 3004:任务所在机器人从控制台被删除 4001:任务被api停止 4002:任务所在分组被api删除 4004:任务所在机器人被api删除 4005:api清除队列导致任务异常终止 |
请求示例:
https://console-rpa.aliyun.com/rpa/openapi/raas/task/ListTaskDetails?
&TaskIds=%5B014b9ab1-51c2-446f-b8c1-b685429a8764%5D
&公共请求参数返回示例:
{
"requestId": "0c9be650-****-****-****-7f29841d8207",
"success": true,
"code": 0,
"msg": "调用成功",
"msgCode": "result.success",
"data": [{
"TaskId": "db23a4a0-****-****-****-667453882246",
"TaskStatus": "complete",
"TaskStatusLatestUpdateTime": "2022-07-21 16:36:46",
"TaskBeginTime": "2022-07-21 16:36:37",
"TaskEndTime": "2022-07-21 16:36:46",
"AllocateMode": "auto",
"TaskPriority": 50,
"AppId": "0925860d-****-****-****-446d0cdb2ff5",
"AppParams": null,
"TaskResult": null,
"RobotId": "6579633******178CAC2FCBD5BD0B4EC",
"PackId": "nO5494bS",
"CallbackUrl": "http://example.callback.com",
"TaskErrorInfo":"{
"Source": "client",
"Description": "等待控件超时",
"Operator": {
"Id": "exampleUserId",
"Name": "exampleUserName"
},
"StatusCode": {
"Code": "0000",
"Value": "terminatedUnexpected"
}
}",
}],
"pager": null,
"instanceId": null
}