全部产品
云市场

list

更新时间:2020-05-11 11:48:41

查询当前用户下所有服务型任务

服务端需要V3.4.7及以上版本。

调用地址:http://{rpahost}/rpa/api/ak/server/task/list
调用方式:GET
返回类型:JSON
请求参数(Headers):

参数

类型

描述

accessKey

String

从控制台中获取到的 accessKey

accessKeySecret

String

从控制台中获取到的 accessKeySecret

请求参数(Params):

key

类型

必选

可选值

默认值

说明

taskScheduleName

string

-

-

任务名(模糊匹配)

taskScheduleStatus

string

-

-

任务状态

scheduleStartTimeGreaterThan

string

-

-

以任务开始时间为目标值的一个时间区间

eg. “yyyy-mm-dd HH:MM:SS”

scheduleStartTimeLessThan

string

-

-

currentPage

int

-

-

分页参数(当前页)

当两个分页参数都不传时默认查询全部

pageSize

int

-

-

页参数(每页数量)

请求示例:

  1. curl -H "accessKey:54f7261d92xxxxxx" -H "accessKeySecret:b485d705-91e9-426d-b8d2-3f0b3cxxxxxx" http://{rpahost}/rpa/api/ak/server/task/list -G --data-urlencode 'name=服务型' -d 'status=running' --data-urlencode 'scheduleStartBeginTime=2019-03-22 13:06:23' -d 'currentPage=1' -d 'pageSize=10'

正常返回示例:

  1. {
  2. "success": true,
  3. "code": 0,
  4. "msg": "SUCCESS",
  5. "data": [
  6. {
  7. "taskScheduleId": 2261,
  8. "taskScheduleUuid": "01781f6d-bac9-46fb-8193-383b32xxxxxx",
  9. "taskScheduleName": "服务自动任务-服务型机器人测试-10-2019-10-28 17:56:35",
  10. "taskScheduleStatus": "completion",
  11. "appUuid": "ae293b38-d63b-4e4a-867b-bae4a9xxxxxx",
  12. "appName": "服务型机器人测试-10",
  13. "appId": 1352,
  14. "clientName": "RPATEST",
  15. "clientUuid": "499a9ed1-43e1-49fb-8feb-577da4xxxxxx",
  16. "uuid": "49a0d2ea-5883-4e3a-a781-fbb39fxxxxxx",
  17. "scheduleStartTime": "2019-10-28 17:56:36",
  18. "scheduleEndTime": "2019-10-28 17:57:00",
  19. "creatorId": 62,
  20. "creatorName": "rpatest",
  21. "creatorNickName": "RPATEST"
  22. },
  23. {
  24. "taskScheduleId": 2260,
  25. "taskScheduleUuid": "1daec526-f3f7-4730-8f90-ded87dxxxxxx",
  26. "taskScheduleName": "服务自动任务-服务型机器人测试-10-2019-10-28 17:54:25",
  27. "taskScheduleStatus": "completion",
  28. "appUuid": "ae293b38-d63b-4e4a-867b-bae4a9xxxxxx",
  29. "appName": "服务型机器人测试-10",
  30. "appId": 1352,
  31. "clientName": "RPATEST",
  32. "clientUuid": "499a9ed1-43e1-49fb-8feb-577da4xxxxxx",
  33. "uuid": "ece27991-7516-489b-960c-647fd6xxxxxx",
  34. "scheduleStartTime": "2019-10-28 17:54:26",
  35. "scheduleEndTime": "2019-10-28 17:54:51",
  36. "videoDownloadUrl": "/rpa/file/get/video/zip/ae293b38-d63b-4e4a-867b-bae4a9xxxxxx/569b0586-0f7d-4a22-903a-862ff5xxxxxx",
  37. "creatorId": 62,
  38. "creatorName": "rpatest",
  39. "creatorNickName": "RPATEST"
  40. }
  41. ],
  42. "pager": {
  43. "currentPage": 1,
  44. "totalPage": 18,
  45. "pageSize": 10,
  46. "total": 173,
  47. "limit": 10,
  48. "offset": 0
  49. }
  50. }

字段

描述

success

这个接口内部运行是否成功,枚举值详见code码说明

code

这个接口内部运行状态码,成功为0,枚举值详见code码说明

msg

这个接口内部运行后的信息描述,成功为“SUCCESS”,枚举值详见code码说明

data

id

任务id

uuid

任务唯一标识符

name

任务名称

status

任务状态

appUuid

应用唯一标识符

appId

应用id

clientName

机器人(客户端)名称

clientUuid

机器人(客户端)唯一标识符

taskUuid

任务唯一标识符

scheduleStartTime

任务开始时间

scheduleEndTime

任务结束时间

videoDownloadUrl

任务录屏文件的下载地址(如果该任务没有录屏,则没有该字段)

creatorId

任务创建者id

creatorName

任务创建者账号名称

creatorNickName

任务创建者昵称

pager

currentPage

当前所在的分页数

totalPage

总的分页数

pageSize

每页数量

total

查询结果的总数量

limit

当前页条数

offset

起始位置

错误码定义:

错误码 错误信息 描述
404 请求资源不存在

请求资源不存在,请核对请求的路径

401 您无该功能的权限,请核对AK信息

您无该功能的权限,请核对AK信息

405 请求方法错误

请求方法错误,请核对你请求的方法

500 参数错误 参数错误