CreateTask

更新时间:
复制为 MD 格式

作用:创建服务型任务

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

类型:POST

使用方式:

  • 任务队列限制:每个机器人等待运行的任务数量最大为100,每个机器人分组等待运行的任务数量最大为1000。若超过等待运行的任务数量上限,任务创建失败

  • 请求参数需通过body传参方式

  • 该接口支持幂等调用,详见幂等调用

使用限制:

重要

接口调用限制详见调用限制

请求参数:

名称

类型

是否必选

示例值

描述

AppId

String

2e8e34bf -****-****-****- e1d0add3d95e

  • 应用ID。可在RPA控制台的“企业应用-企业应用列表”菜单中查看到应用ID。

说明

不同于本地型机器人的应用权限限制,服务型任务可执行本租户下所有的RPA应用。

AppParams

Array of Json,序列化方式:simple

[{"name":"参数1","value":""},{"name":"参数2","value":""}]

应用入参,执行应用所需参数。最大长度为40KB

AllocateMode

String

auto

  • 分配机器人模式,共有自动分配(auto)、手动指定(manu)两种模式

  • 为空时默认使用auto,即按照机器人分组进行自动匹配

  • 如果指定机器人运行,该入参需要为manu,并需要RobotId=<机器人ID>

PackId

String

bv2XPrDl

  • 配合AllocateMode=auto(或为空)时使用。

  • 为空默认使用服务型机器人的默认分组。

  • 如果需要指定分组,需要传入机器人分组ID。

RobotId

String

11DC81 ****** 4E463B1E538436035653

  • 配合AllocateMode=manu时使用。

  • 需要传入指定的机器人ID。

TaskPriority

Integer

85

任务优先级,整数,默认值为50。取值范围:1-100,其中100为优先级最高。

CallbackUrl

String

http://example.callback.com/example

回调地址,需要填写完整的url,支持httphttps。回调仅支持发送POST请求。

RPA服务端发起回调请求,因此需要确保RPA服务端到您的回调地址之间网络的联通。

回调最大重试次数为3次,具体结果请在控制台任务详情中查看,回调说明详见下方描述。

AppVersion

String

1.0.0

需要执行的应用的版本。为空默认使用最大版本。

回调说明:

在创建任务时若是有指定有效的httphttps回调地址,在相应任务状态改变后会触发回调,每次触发回调会有最大3次的重试次数。

如果您提供的回调API需要认证鉴权,建议使用https+token的方式,token可以放在回调地址的Query参数部分,例如:https://example.callback.com/example?token=12345。

说明
  1. 回调请求中,headerContent-Type=applicationx-www-form-urlencoded

  2. 回调仅支持发送POST请求,只在body中传送回调内容

回调请求的body结构说明如下:

名称

类型

示例值

描述

taskId

String

537a6966-****-****-****-f80976e2f5a6

任务ID

taskStatus

String

complete

变化后的任务状态,值分配为

  • 异常结束(terminated)

  • 正常结束(complete)

  • 正在运行(running)

taskResult

String

cnBh5pyN5 ****** L5py65Zmo5Lq6

  • 应用执行结果。需由用户在自动化流程中自动添加,使用方法和限制详见task_result

  • 该字段只有在taskStatus=complete时才会传,并且内容会base64encode后传出

示例body值:

taskId=537a6966-****-****-****-f80976e2f5a6&taskStatus=running&taskResult=cnBh5pyN5Yqh******65Zmo5Lq6

RPA服务端发起的回调记录可在RPA控制台的“服务型机器人-任务管理-任务详情”中查看,如下所示

image

返回参数:

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

名称

类型

示例值

描述

TaskId

String

48bb0d07 -****-****-****- cbe75d646bb5

任务ID

请求示例:

https://console-rpa.aliyun.com/rpa/openapi/raas/task/CreateTask?
&AllocateMode=auto
&AppId=0925860d-b652-****-****-****-446d0cdb2ff5
&PackId=nO5494bS
&TaskPriority=39
&公共请求参数

返回示例:

{
	"requestId": "95ea6575-****-****-****-4f949626b3fd",
	"success": true,
	"code": 0,
	"msg": "调用成功",
	"msgCode": "result.success",
	"data": {
		"TaskId": "cde18c63-****-****-****-8623299a0116"
	},
	"pager": null,
	"instanceId": null
}