本產(chǎn)品（
任務(wù)調(diào)度SchedulerX/2019-04-30）的OpenAPI采用RPC簽名風(fēng)格，簽名細(xì)節(jié)參見(jiàn)簽名機(jī)制說(shuō)明。我們已經(jīng)為開(kāi)發(fā)者封裝了常見(jiàn)編程語(yǔ)言的SDK，開(kāi)發(fā)者可通過(guò)下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無(wú)需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過(guò)簽名機(jī)制進(jìn)行自簽名對(duì)接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費(fèi) 5個(gè)工作日左右。因此建議加入我們的服務(wù)釘釘群（78410016550），在專(zhuān)家指導(dǎo)下進(jìn)行簽名對(duì)接。在使用API前，您需要準(zhǔn)備好身份賬號(hào)及訪問(wèn)密鑰（AccessKey），才能有效通過(guò)客戶端工具（SDK、CLI等）訪問(wèn)API。細(xì)節(jié)請(qǐng)參見(jiàn)獲取AccessKey。
服務(wù)地域
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeRegions | 查看可選的地域 | 返回可用region列表。 |
命名空間
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateNamespace | 創(chuàng)建命名空間 | 創(chuàng)建命名空間。 |
| ListNamespaces | 獲取命名空間列表 | 獲取命名空間列表。 |
應(yīng)用分組
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateAppGroup | 創(chuàng)建應(yīng)用分組 | 創(chuàng)建應(yīng)用分組，返回appKey。 |
| GetAppGroup | 獲取應(yīng)用分組詳情 | 獲取應(yīng)用分組。 |
| DeleteAppGroup | 刪除應(yīng)用分組 | 刪除應(yīng)用分組。 |
| UpdateAppGroup | 更新應(yīng)用分組 | 更新應(yīng)用分組。 |
| ListGroups | 獲取應(yīng)用分組列表 | 獲取應(yīng)用列表。 |
| GetWorkerList | 獲取接入某個(gè)應(yīng)用的worker列表 | 獲取接入某個(gè)應(yīng)用的worker列表。 |
工作流
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateWorkflow | 創(chuàng)建工作流 | 創(chuàng)建工作流，默認(rèn)禁用狀態(tài)，更新完DAG后，需要手動(dòng)或者通過(guò)API啟動(dòng)用工作流，只有專(zhuān)業(yè)版才支持。 |
| UpdateWorkflow | 更新工作流的基本信息 | 更新工作流的基本信息，只有專(zhuān)業(yè)版才支持。 |
| UpdateWorkflowDag | 更新工作流的DAG | 更新工作流的節(jié)點(diǎn)及依賴(lài)關(guān)系，專(zhuān)業(yè)版應(yīng)用才支持。 |
| DeleteWorkflow | 刪除指定工作流 | 刪除指定工作流。 |
| DisableWorkflow | 禁用指定工作流 | 禁用指定工作流。 |
| EnableWorkflow | 啟用指定工作流 | 啟用指定工作流。 |
| GetWorkFlow | 獲取工作流詳情和依賴(lài)關(guān)系 | 獲取工作流信息。 |
| ExecuteWorkflow | 觸發(fā)一次工作流 | 觸發(fā)一次工作流立即運(yùn)行。 |
| GetWorkflowInstance | 獲取工作流實(shí)例詳情及DAG | 獲取指定工作流實(shí)例的詳情，包含實(shí)例狀態(tài)，依賴(lài)關(guān)系，每個(gè)任務(wù)實(shí)例的狀態(tài)等。專(zhuān)業(yè)版應(yīng)用才支持。 |
| ListWorkflowInstance | 獲取工作流實(shí)例列表 | 獲取工作流的歷史執(zhí)行記錄，只有專(zhuān)業(yè)版才支持。 |
| SetWfInstanceSuccess | 標(biāo)記工作流實(shí)例成功 | 強(qiáng)制設(shè)置工作流實(shí)例狀態(tài)為成功狀態(tài)，只有專(zhuān)業(yè)版才支持。 |
任務(wù)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateJob | 創(chuàng)建任務(wù)并返回任務(wù)ID | 創(chuàng)建任務(wù)并返回任務(wù)ID。 |
| DeleteJob | 刪除指定任務(wù) | 刪除指定任務(wù)。 |
| BatchDeleteJobs | 批量刪除任務(wù) | 批量刪除任務(wù)。 |
| UpdateJob | 更新任務(wù)配置信息 | 更新任務(wù)配置信息。默認(rèn)先調(diào)用獲取任務(wù)找到對(duì)應(yīng)字段進(jìn)行修改。 |
| DisableJob | 停用指定任務(wù) | 停用指定任務(wù)。 |
| BatchEnableJobs | 批量啟用任務(wù) | 批量啟用任務(wù)。 |
| BatchDisableJobs | 批量禁用任務(wù) | 批量禁用任務(wù)。 |
| EnableJob | 啟用指定任務(wù) | 啟用指定任務(wù)。 |
| GetJobInfo | 獲取指定Jobid任務(wù)詳情 | 獲取指定Jobid任務(wù)詳情，通常用來(lái)更新任務(wù)。 |
| ListJobs | 獲取任務(wù)列表 | 獲取任務(wù)列表。 |
| ExecuteJob | 觸發(fā)一次任務(wù) | 觸發(fā)一次任務(wù)立即運(yùn)行。 |
| DesignateWorkers | 指定機(jī)器 | 指定機(jī)器。 |
| RerunJob | 重刷任務(wù)的歷史數(shù)據(jù) | 重跑任務(wù)的歷史數(shù)據(jù)，只有專(zhuān)業(yè)版才支持。 |
任務(wù)實(shí)例
| API | 標(biāo)題 | API概述 |
|---|---|---|
| StopInstance | 終止正在運(yùn)行的實(shí)例 | 終止某次正在運(yùn)行的實(shí)例。 |
| GetJobInstance | 獲取指定任務(wù)實(shí)例詳情 | 返回任務(wù)實(shí)例的信息，可以查看任務(wù)實(shí)例的狀態(tài)和進(jìn)度。 |
| GetJobInstanceList | 獲取指定任務(wù)ID的執(zhí)行實(shí)例列表 | 根據(jù)關(guān)鍵字過(guò)濾，返回任務(wù)執(zhí)行的歷史記錄。 |
| RetryJobInstance | 重跑任務(wù)實(shí)例 | 重跑失敗或者成功狀態(tài)的任務(wù)實(shí)例，只有專(zhuān)業(yè)版才支持。 |
| SetJobInstanceSuccess | 標(biāo)記任務(wù)實(shí)例成功 | 強(qiáng)制設(shè)置任務(wù)實(shí)例狀態(tài)為成功狀態(tài)，只有專(zhuān)業(yè)版才支持。 |
權(quán)限設(shè)置
| API | 標(biāo)題 | API概述 |
|---|---|---|
| GrantPermission | 給指定分組授權(quán) | 給指定分組授權(quán)。 |
| RevokePermission | 取消指定阿里云子賬號(hào)的權(quán)限 | 取消指定阿里云子賬號(hào)的權(quán)限。 |
日志
| API | 標(biāo)題 | API概述 |
|---|---|---|
| GetLog | 查詢?nèi)罩?/span> | 通過(guò)該API可以查詢?nèi)蝿?wù)的運(yùn)行日志，需要開(kāi)通專(zhuān)業(yè)版才支持。 |
路由策略
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DeleteRouteStrategy | 刪除路由策略 | 刪除路由策略。 |
| BatchDeleteRouteStrategy | 批量刪除路由策略 | 批量刪除路由策略。 |
| CreateRouteStrategy | 創(chuàng)建路由策略 | 創(chuàng)建路由策略。 |
其他
| API | 標(biāo)題 | API概述 |
|---|---|---|
| GetOverview | 獲取概覽數(shù)據(jù)信息 | 獲取專(zhuān)業(yè)版應(yīng)用任務(wù)調(diào)度概覽數(shù)據(jù)信息。 |