調用地址: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 | 強制結束時間; |
yearMonthDay | String | 否 | 2020-04-27 | 指定年月日 |
hourMinute | String | 否 | 05:05 | 指定時分 |
specifiedValue | String | 否 | 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
}