queryTaskSchedules
调用地址:console-rpa.aliyun.com/rpa/openapi/task/queryTaskSchedules
调用方式:GET
返回类型:JSON
接口说明:查询计划任务列表
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
taskScheduleName | String | 否 | TestAPP1 | 计划任务名称 |
taskScheduleStatus | String | 否 | completion | |
startTime | String | 否 | 2020-04-28 15:24:24 | 计划任务开始时间 |
endTime | String | 否 | 2020-04-28 15:24:43 | 计划任务结束时间 |
currentPage | Integer | 否 | 1 | 展示页码 |
pageSize | Integer | 否 | 1 | 每页展示记录数 |
type | String | 否 | service | 任务类型, 可选参数【service ,unattended】;默认为service 。 服务型任务:service 定时型任务:unattended |
返回参数
返回参数公共字段请查阅返回结果,返回参数中的 data
字段说明如下:
名称 | 类型 | 示例值 | 描述 |
uuid | String | 8c809cdf-adba-44fb-b7c0-f53c6f4cc734 | 计划任务唯一标识符 |
appId | String | fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d | 应用唯一标识符 |
name | String | SystemAutoTask-TestAPP1-2020-04-28 15:24:24 | 计划任务名称 |
groupId | String | b8e097d8-605c-47cf-a5a3-db5d13f8b4ca | 企业唯一标识符 |
status | String | completion | 计划任务状态 |
creator | String | 93bf42a1-6e65-4912-98b2-4d5ec0e6260a | 创建者 |
scheduleType | String | immediate | 计划任务类型 |
scheduleExpress | null | ||
scheduleCron | String | null | 计划任务规则 |
scheduleStartDate | Date | null | 计划任务开始时间 |
scheduleEndDate | Date | null | 计划任务结束时间 |
nextTaskTime | Date | null | 下次计划任务结束时间 |
clientType | String | robot_service | 客户端类型 |
appName | String | TestAPP1 | 应用名称 |
clientCount | Long | 1 | 应用执行的客户端数量 |
creatorName | String | ss-test | 创建者的账户名称 |
creatorNickName | String | 超级管理员 | 创建者的昵称 |
示例
请求示例:
https://console-rpa.aliyun.com/rpa/openapi/task/queryTaskSchedules?<公共请求参数>
&taskScheduleName=TestAPP1
&taskScheduleStatus=completion
&startTime=2020-04-28 15:24:24
&endTime=2020-04-28 15:24:43
¤tPage=1
&pageSize=1
&type = service
返回示例:
{
"requestId":"1986a216-6f70-42a6-b5e1-4e1a5143c372",
"success":true,
"code":0,
"msg":"调用成功",
"msgCode":"result.success",
"data":[
{
"uuid":"8c809cdf-adba-44fb-b7c0-f53c6f4cc734",
"appId":"fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d",
"name":"SystemAutoTask-TestAPP1-2020-04-28 15:24:24",
"groupId":"b8e097d8-605c-47cf-a5a3-db5d13f8b4ca",
"status":"completion",
"creator":"93bf42a1-6e65-4912-98b2-4d5ec0e6260a",
"scheduleType":"immediate",
"scheduleExpress":null,
"scheduleCron":null,
"scheduleStartDate":null,
"scheduleEndDate":null,
"nextTaskTime":null,
"clientType":"robot_service",
"appName":"TestAPP1",
"clientCount":1,
"creatorName":"ss-test",
"creatorNickName":"超级管理员"
}
],
"pager":{
"currentPage":1,
"totalPage":15,
"pageSize":1,
"total":15,
"limit":1,
"offset":0
}
}