本產品（
任務調度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 | 查詢日志 | 查詢日志。 |