自用API-查询任务执行记录列表

2022-11-03 1078

查询任务执行记录

简要描述
  • 通过时间范围来查询要执行和已执行的任务记录。一个计划会生成多个任务、一个任务下会有多个执行结果,每一个结果对应为一条数据输出。
请求URL
  • /rpa/company/tasks
请求方式
  • GET

请求参数

Headers
参数名 参数描述 必选 类型 说明
Authorization 身份令牌 string AppToken
Query
参数名 参数描述 必选 类型 说明
timeFrom 时间 从 number 时间戳(毫秒)
timeTo 时间 至 number 时间戳(毫秒)
planId 计划Id number
pageNum 页码 number
pageSize 每页条数 number 每页最多500条
提交数据样例
/rpa/company/tasks?pageNum=1&pageSize=500&planId=123

返回数据

参数名 参数描述 必选 类型 说明
code 状态码 number -
msg 提示信息 string(1024) -
data 业务数据 object -
-pageNum 页码 number
-pageSize 每页条数 number
-totalCount 总数 number
-curPage 当前页数据 object[]
--planName 计划名称 string(128) 该任务所属的计划
--planStatus 计划状态 string(50) ENABLED:生效中,DELETED:已删除,STOP:运行结束(执行完毕)OBSOLETE:过期
--planId 计划ID string(32) 该任务所属的计划ID
--taskId 任务ID string(32) 一个计划下会有多个任务
--taskStatus 任务状态 string(50) READY:待运行,
RUNNING:运行中,
STOP:被终止,
TIMEOUT:任务超时但未结束,
FAIL:任务未正常运行完成,

SUCCESS:任务运行完成,任务运行完成后会输出运行结果,无论运行结果是否有文件输出,任务的状态都是运行完成,当任务状态为SUCCESS时,认为结果已经输出完成,可以调用tasks/results接口查看该任务的运行结果列表,根据结果的状态决定是否对某些结果进行重试

REDO_RUNNING:重试执行中,
REDO_OVER:重试结束
NO_VALID_STORE:无有效店铺,该状态可进行任务重试
NO_VALID_SITE:无有效站点,该状态可进行任务重试
RPA_UPGRADING:RPA在升级中,无法运行
NO_ACCESS4PAY:无付费权限
NO_BALANCE:账户余额不足
--cost 费用 number 单位/元
--runCount 运行次数 number
--outPutCount 输出文件数 number
返回数据样例
  {
    "code": 0,
    "data": {
        "curPage": [
            {
                "cost": 0.0,
                "outPutCount": 0,
                "planId": "8693",
                "planName": "BI服务自动任务-店铺状态(Amazon)",
                "planStatus": "ENABLED",
                "runCount": 27,
                "taskId": "1408288208650269",
                "taskStatus": "SUCCESS"
            },
            {
                "cost": 0.0,
                "outPutCount": 0,
                "planId": "8693",
                "planName": "BI服务自动任务-店铺状态(Amazon)",
                "planStatus": "ENABLED",
                "runCount": 27,
                "taskId": "1408469404680336",
                "taskStatus": "SUCCESS"
            }
        ],
        "pageNum": 1,
        "pageSize": 2,
        "totalCount": 1048
    },
    "msg": "SUCCESS"
}