本产品（
任务调度XXLJOB版 /2024-06-24）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
集群
| API | 标题 | API概述 |
|---|---|---|
| CreateCluster | 创建集群 | 创建集群。 |
| UpdateCluster | 更新集群 | 更新集群。 |
| DeleteCluster | 释放删除集群 | 释放删除集群。 |
| GetCluster | 获取集群详细信息 | 获取集群详细信息。 |
| ListClusters | 查询实例列表 | 查询实例列表。 |
应用
| API | 标题 | API概述 |
|---|---|---|
| CreateApp | 创建应用 | 创建应用。 |
| UpdateApp | 更新应用 | 更新应用分组。 |
| DeleteApp | 删除应用 | 删除应用分组。 |
| ListApps | 获取应用列表 | 获取应用列表。 |
| ListAppNames | 获取应用名称列表 | 获取应用名称列表。 |
| ListLables | 获取executor的label列表 | 获取executor的label列表。 |
| ListExecutors | 查询Executor列表 | 查询Executor列表。 |
任务
| API | 标题 | API概述 |
|---|---|---|
| CreateJob | 创建任务 | 创建任务。 |
| UpdateJob | 更新任务 | 更新任务信息。 |
| DeleteJobs | 批量删除任务 | 批量删除任务。 |
| OperateEnableJobs | 批量启用任务 | 批量启用任务。 |
| OperateDisableJobs | 批量禁用任务 | 批量禁用任务。 |
| OperateRerunJob | 重刷任务历史数据 | 重刷任务历史数据。 |
| ListJobs | 获取任务列表 | 获取任务列表。 |
| GetDesigateInfo | 获取指定机器信息 | 获取指定机器信息。 |
任务执行
| API | 标题 | API概述 |
|---|---|---|
| OperateStopJobExecution | 停止正在运行的任务实例 | 停止正在运行的任务实例。 |
| OperateDesignateExecutors | 指定执行器 | 指定执行器。 |
| OperateRetryJobExecution | 重跑任务实例 | 重跑失败的任务实例。 |
| OperateExecuteJob | 运行一次任务 | 运行一次任务。 |
| GetJobExecutionProgress | 获取任务执行的详情 | 获取任务执行的详情。 |
| ListJobExecutions | 获取任务实例列表 | 获取任务实例列表。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| ListRegions | 获取Region列表 | 获取所有region列表。 |
| ListRegionZone | 获取可用区列表 | 获取可用区列表。 |
| ListCalendarNames | 获取日历名字列表 | 获取日历名字列表。 |
| ListScheduleEvent | 查询调度事件 | 查询调度事件。 |
| ListAlarmEvent | 获取报警事件 | 获取报警事件。 |
| ListScheduleTimes | 获取指定时间类型和表达式未来5次调度时间 | 获取指定时间类型和表达式未来5次调度时间。 |
| ImportJobs | 批量导入任务 | 批量导入任务。 |
| ImportCalendar | 导入日历 | 导入日历。 |
| ExportJobs | 批量导出任务 | 批量导出任务信息。 |
| GetLog | 查询日志 | 查询日志。 |