ListTasks

更新时间:
复制为 MD 格式

作用:查询任务列表

路径:/rpa/openapi/raas/task/ListTasks

类型:GET

使用方式:

  • 无特殊说明

请求参数:

名称

类型

是否必选

示例值

描述

TaskStatus

String

terminated

任务状态。可筛选下列4种状态值:

  • 异常结束(terminated)

  • 正常结束(complete)

  • 等待运行(waiting)

  • 正在运行(running)

RobotId

String

11DC8 ****** A4E463B1E538436035653

机器人ID,不能和机器人分组ID同时传入

PackId

String

bv2XPrDl

机器人分组ID,不能和机器人ID同时传入

CurrentPage

Integer

1

当前页码,默认第1

PageSize

Integer

20

每页显示记录数,默认每页20个,最大能返回100条数据

TimeType

String

createTime

  • 指定筛选的时间类型。可筛选的时间类型包括

    • 任务创建时间(createTime)

    • 任务开始时间(beginTime)

    • 任务结束时间(endTime)

  • 如使用,需配套传入FromTimeToTime

FromTime

String

2025-01-15T08:00:00Z

  • 该字段指定筛选时间段的开始部分,只返回在该时间点及之后的任务

  • FromTime、ToTime需要成对使用,且FromTimeToTime时间跨度不能超过24小时

  • 使用 ISO 8601 和 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。例如,示例值中的2025-01-15T08:00:00Z为北京时间202511516

ToTime

String

2025-01-15T08:02:00Z

  • 该字段指定筛选时间段的结束部分,只返回在该时间点及之前的任务

  • FromTime、ToTime需要成对使用,且FromTimeToTime时间跨度不能超过24小时

  • 使用 ISO 8601 和 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

返回参数:

返回参数公共字段请查阅返回结果,返回参数中的 data 字段说明如下:

名称

类型

示例值

描述

TaskId

String

2610971f -****-****-****- 62276a17de57

任务ID

TaskStatus

String

complete

任务状态:

  • 异常结束(terminated)

  • 正常结束(complete)

  • 等待运行(waiting)

  • 正在运行(running)

AllocationMode

String

manu

机器人与任务的分配策略,共有自动分配(auto)、手动指定(manu)两种模式

TaskCreateTime

String

2022-05-16 20:00:00

任务创建时间

TaskBeginTime

String

2022-05-16 20:00:00

任务开始时间

TaskEndTime

String

2022-05-16 21:07:03

任务结束时间

TaskPriority

Integer

50

任务优先级

AppId

String

08f653b0- -****-****-****- 0ff03cc87b97

应用ID

CallbackUrl

String

http://example.callback.com

创建任务时指定的回调地址

RobotId

String

11DC817 ****** 4E463B1E538436035653

机器人ID

PackId

String

bv2XPrDl

机器人分组ID

请求示例:

https://console-rpa.aliyun.com/rpa/openapi/raas/task/ListTasks?
&RobotId=A393EF68C917******87353484322F7
&currentPage=1
&PageSize=2
&公共请求参数

返回示例:

{
	"requestId": "58fe68d1-****-****-****-519ab8911c49",
	"success": true,
	"code": 0,
	"msg": "调用成功",
	"msgCode": "result.success",
	"data": [{
		"TaskId": "6868d68e-****-****-****-b449d9536362",
		"TaskStatus": "complete",
		"AllocationMode": "auto",
		"TaskBeginTime": "2022-07-20 23:14:49",
		"TaskEndTime": "2022-07-20 23:15:41",
		"TaskPriority": 30,
		"AppId": "9488635a-****-****-****-664c84c188fc",
		"CallbackUrl": "http://30.11.X.X/rpa/api/csrf/ajax",
		"RobotId": "A393EF68C917B******87353484322F7",
		"PackId": "4f5ffab5-****-****-****-b28efa61d2ea"
	}, {
		"TaskId": "7faf3e08-****-****-****-57feb75aef25",
		"TaskStatus": "terminated",
		"AllocationMode": "auto",
		"TaskBeginTime": "2022-07-20 23:16:27",
		"TaskEndTime": "2022-07-20 23:16:32",
		"TaskPriority": 30,
		"AppId": "9488635a-****-****-****-664c84c188fc",
		"CallbackUrl": "http://30.11.X.X/rpa/api/csrf/ajax",
		"RobotId": "A393EF68C917BFA******353484322F7",
		"PackId": "4f5ffab5-****-****-****-b28efa61d2ea"
	}],
	"pager": {
		"currentPage": 1,
		"totalPage": 11,
		"pageSize": 2,
		"total": 21,
		"limit": 2,
		"offset": 0
	},
	"instanceId": null
}