如何调用createTaskSchedule创建计划任务_机器人流程自动化(Robotic Process Automation)-阿里云帮助中心

调用地址：console-rpa.aliyun.com/rpa/openapi/task/createTaskSchedule

调用方式：POST

返回类型：JSON

接口说明：创建计划任务

请求参数

名称	类型	是否必选	示例值	描述
appId	String	是	fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d	应用唯一标识符
name	String	是	测试	计划任务名称
clientIds	String	是	5E77DA4EB87BCFB62A8B9527626A47F4	客户端唯一标识符，一次查询多个客户端的任务时，使用‘,’连接客户端唯一识别符，如：5E77DA4EB87BCFB62A8B9527626A47F4,50E6071F3ABCB36B6DECCE2BB4C2A303
scheduleType	String	是	immediate	任务类型 ; specified_time（指定时间）,immediate（立即执行）,specified_interval_time（指定间隔时间）,day_interval（指定间隔天数）,week_interval（指定每隔周几）,month_interval（指定每隔几月）,cron_express（直接指定 cron 表达式）
scheduleConfig	String	是	{"yearMonthDay":"2020-04-27"}	计划任务参数
appParams	Json数组	否	[{“type”:0,”name”:”参数1”,”default”:””,”value”:””},{“type”:0,”name”:”参数2”,”default”:””,”value”:””}]	计划任务执行所需参数，数字所代表的意思 TextEdit = 0,ComboBox = 1, CheckedComboBox = 2, OpenFile = 3,OpenDir = 4,DateEdit = 5,ColorPick = 6,PasswordTextEdit = 7, HtmlTextEdit = 8, MultiTextEdit = 9

scheduleConfig参数汇总说明

名称	类型	是否必选	示例值	描述
errorHandling	boolean	否	false	errorHandling决定执行失败的情况下是否重试。若errorHandling为false，则异常的任务直接结束，不重试；若errorHandling为true，当应用执行失败时，机器人会立即重试，允许最多执行三次。
isQueueUpType	boolean	否	false	是否放入队列；选传
taskNumber	Integer	否	1	任务数；选传
tasKPriority	Integer	否	50	优先级 >=0 数字越大，优先级越高
emails	String	否	test@example.com	邮箱参数,多个邮箱时，以逗号间隔
forceRadio	Boolean	否	false	是否有强制结束时间
scheduleEndDt	String	否	2022-09-25 10:21	强制结束时间；`forceRadio为true是，需要有强制结束时间`
yearMonthDay	String	否	2020-04-27	指定年月日
hourMinute	String	否	05:05	指定时分
specifiedValue	String	否	intervalDay	间隔值：`intervalMinute`,`intervalHour`,`intervalDay`
intervalHour	String	否	1	间隔时， 0-23的值
intervalMinute	String	否	1	间隔分，0-60的值
intervalDay	String	否	1	间隔天，0-29的值
weeks	String	否	1	1-7的以逗号间隔的字符串组合
month	String	否	1	1-31以逗号间隔的字符串组合
taskScheduleStartDate	String	否	2022-09-24 10:21	计划任务开始时间

scheduleConfig有如下几种字符串组合：指定时间：specified_time 对应的scheduleConfig

    {
     "yearMonthDay":"2020-04-27",
     "hourMinute":"15:18"
    }

说明

用户可以自由从汇总参数中添加errorHandling 、isQueueUpType、taskNumber、tasKPriority、emails 参数

立即执行：immediate 对应的scheduleConfig

{
"yearMonthDay":"2020-04-27",
"hourMinute":"15:18" 
}

说明

用户可以自由从汇总参数中添加errorHandling 、isQueueUpType、taskNumber、tasKPriority、emails 参数

指定间隔时间执行：specified_interval_time 对应的scheduleConfig

    {
    "scheduleEndDt":"2020-05-29 18:20:00 "
    "yearMonthDay":"2020-04-29",
    "hourMinute":"17:20" ,
    "specifiedValue":"intervalHour", 
    "intervalHour" :9 ,
    "intervalDay ": 0 ,
    "intervalMinute": 0"
     }

说明

specifiedValue的值对应intervalHour、intervalDay、intervalMinute；当specifiedValue == intervalDay时，intervalDay需要大于0,且intervalHour、intervalMinute可不传；同理intervalHour、intervalMinute； forceRadio ；是固定参数true 用户可以自由从汇总参数中添加errorHandling 、isQueueUpType、taskNumber、tasKPriority、emails 参数

每周重复：week_interval

{ 
    "scheduleEndDt":"2020-05-29 18:20:00 "
   "yearMonthDay":"2020-04-27",
   "hourMinute":"21:35" ,
   "weeks":"1,2,3,4,5,6,7"
 }

说明

weeks每周几运行 yearMonthDay + hourMinute每周运行时间；用户可以自由从汇总参数中添加errorHandling 、isQueueUpType、taskNumber、tasKPriority、emails 参数

每月重复：month_interval

{ 
    "scheduleEndDt":"2020-05-29 18:20:00 "
   "hourMinute":"21:35" ,
   "month":"1,2,3,4,5,6,7"
}

返回参数

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

名称	类型	示例值	描述
uuid	String	1c7284b5-b1a0-4db1-8377-6fb3443b5a8b	计划任务唯一标识符
appId	String	fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d	app唯一标识符
name	String	测试	计划任务名称
groupId	String	b8e097d8-605c-47cf-a5a3-db5d13f8b4ca	企业唯一标识符
status	String	wait	计划任务状态
creator	String	93bf42a1-6e65-4912-98b2-4d5ec0e6260a	创建者唯一标识符
scheduleType	String	specified_interval_time	计划任务类型
scheduleExpress	String	{"intervalHour":"1",******,"specifiedValue":"intervalHour"}	计划任务参数
scheduleCron	String	0 0 /1 * * ?	计划任务执行策略cron表达式
scheduleStartDate	Date	1589874420000	计划任务开始时间
scheduleEndDate	Date	1590047160000	计划任务结束时间
nextTaskTime	Date	1589874420000	下次执行开始时间
clientType	String	robot_unattended	客户端类型

示例

请求示例：

https://console-rpa.aliyun.com/rpa/openapi/task/createTaskSchedule?<公共请求参数>
&appId=fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d
&name=测试
&clientIds=5E77DA4EB87BCFB62A8B9527626A47F4
&scheduleType=immediate
&scheduleConfig={"yearMonthDay":"2020-04-27"}
&appParams=[{"type":0,"name":"参数1","default":"","value":""}]

返回示例：

{
    "requestId":"c4719a73-05db-44e9-a7ef-a4eafe886e60",
    "success":true,
    "code":0,
    "msg":"调用成功",
    "msgCode":"result.success",
    "data":{
        "uuid":"1c7284b5-b1a0-4db1-8377-6fb3443b5a8b",
        "appId":"fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d",
        "name":"测试",
        "groupId":"b8e097d8-605c-47cf-a5a3-db5d13f8b4ca",
        "status":"wait",
        "creator":"93bf42a1-6e65-4912-98b2-4d5ec0e6260a",
        "scheduleType":"specified_interval_time",
        "scheduleExpress":"{"intervalHour":"1","weeks":[],"scheduleEndDt":"2020-05-21 15:46","intervalMinute":0,"hourMinute":"15:47","clientIds":["45E2D8F778B0A38C85344B6B2EF10FD4"],"yearMonthDay":"2020-05-19","emails":[],"scheduleType":"specified_interval_time","month":[],"appId":"fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d","intervalDay":0,"name":"测试","forceRadio":true,"scheduleCron":"0 0 /1 * * ?","tasKPriority":"","taskNumber":1,"errorHandling":false,"specifiedValue":"intervalHour"}",
        "scheduleCron":null,
        "scheduleStartDate":1589874420000,
        "scheduleEndDate":1590047160000,
        "nextTaskTime":1589874420000,
        "clientType":"robot_unattended"
    },
    "pager":null
}