本产品（SchedulerX3/2024-06-24）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
集群
|
API |
标题 |
API概述 |
| CreateCluster | 创建集群 | 创建集群。 |
| UpdateCluster | 更新集群 | 更新集群。 |
| DeleteCluster | 释放删除集群 | 释放删除集群。 |
| GetCluster | 获取集群详细信息 | 获取集群详细信息。 |
| ListClusters | 查询实例列表 | 查询实例列表。 |
应用
|
API |
标题 |
API概述 |
| CreateApp | 创建应用 | 创建应用。 |
| UpdateApp | 更新应用 | 更新应用分组。 |
| GetApp | 获取指定应用 | 获取指定应用。 |
| DeleteApp | 删除应用 | 删除应用分组。 |
| ListApps | 获取应用列表 | 获取应用列表。 |
| ListAppNames | 获取应用名称列表 | 获取应用名称列表。 |
| ListLables | 获取executor的label列表 | 获取executor的label列表。 |
| ListExecutors | 查询Executor列表 | 查询Executor列表。 |
执行器
|
API |
标题 |
API概述 |
| UpdateExecutors | 更新执行器 | 更新执行器 |
| GetExecutorConfig | 获取制定执行器配置信息 | 获取制定执行器配置信息 |
| CreateExecutors | 手动导入执行器 | 手动导入执行器 |
任务
|
API |
标题 |
API概述 |
| SyncJobs | 同步任务 | 同步任务。 |
| CreateJob | 创建任务 | 创建任务。 |
| UpdateJob | 更新任务 | 更新任务信息。 |
| UpdateJobScript | 更新任务执行脚本 | 更新任务执行脚本。 |
| DeleteJobs | 批量删除任务 | 批量删除任务。 |
| OperateEnableJobs | 批量启用任务 | 批量启用任务。 |
| OperateDisableJobs | 批量禁用任务 | 批量禁用任务。 |
| OperateRerunJob | 重刷任务历史数据 | 重刷任务历史数据。 |
| ListJobs | 获取任务列表 | 获取任务列表。 |
| ListJobScriptHistory | 获取任务脚本历史列表 | 获取任务脚本历史列表。 |
| GetDesigateInfo | 获取指定机器信息 | 获取指定机器信息。 |
任务执行
|
API |
标题 |
API概述 |
| GetJobExecution | 获取任务执行的详细信息 | 获取任务执行的详细信息。 |
| OperateStopJobExecution | 停止正在运行的任务实例 | 停止正在运行的任务实例。 |
| OperateDesignateExecutors | 指定执行器 | 指定执行器。 |
| OperateRetryJobExecution | 重跑任务实例 | 重跑失败的任务实例。 |
| OperateExecuteJob | 运行一次任务 | 运行一次任务。 |
| GetJobExecutionProgress | 获取分片任务执行的详情 | 获取分片任务执行的详情。 |
| GetJobExecutionThreadDump | 查询任务执行堆栈 | 查询任务执行堆栈。 |
| ListJobExecutions | 获取任务实例列表 | 获取任务实例列表。 |
其他
|
API |
标题 |
API概述 |
| ListK8sResource | 获取k8s资源 | 获取k8s资源 |
| GetLogEvent | 查询事件 | 查询事件。 |
| ImportJobs | 批量导入任务 | 批量导入任务。 |
| ListRegions | 获取Region列表 | 获取所有region列表。 |
| ListRegionZone | 获取可用区列表 | 获取可用区列表。 |
| ListCalendarNames | 获取日历名字列表 | 获取日历名字列表。 |
| ListScheduleEvent | 查询调度事件 | 查询调度事件。 |
| ListAlarmEvent | 获取报警事件 | 获取报警事件。 |
| ListScheduleTimes | 获取指定时间类型和表达式未来5次调度时间 | 获取指定时间类型和表达式未来5次调度时间。 |
| ImportCalendar | 导入日历 | 导入日历。 |
| ExportJobs | 批量导出任务 | 批量导出任务信息。 |
| GetLog | 查询日志 | 查询日志。 |
| OperateMarkSuccessWorkflowExecution | 标记工作流实例为成功状态 | 标记工作流实例为成功状态 |
| OperateSkipJobExecution | 跳过任务实例 | 跳过任务实例 |
| UpdateWorkflow | 更新工作流 | 更新工作流 |
| OperateEnableWorkflows | 启用工作流 | 启用工作流 |
| CreateCalendar | 创建日历 | 创建自定义日历 |
| ImportWorkflows | 导入工作流 | 导入工作流 |
| GetWorkflow | 获取工作流的基本信息 | 获取工作流的基本信息 |
| OperateUnskipJobExecution | 取消跳过任务实例 | 将跳过状态的任务实例恢复 |
| ExportWorkflows | 导出工作流 | 导出工作流为JSON格式，包含工作流基本信息、工作流内所有节点信息、工作流的DAG依赖关系 |
| GetWorkflowDAG | 获取工作流DAG信息 | 获取工作流DAG信息 |
| ListWorkflowVersions | 获取工作流版本列表 | 获取工作流版本列表 |
| OperateHoldJobExecution | 挂起还未执行的任务实例 | 挂起还未执行的任务实例 |
| DeleteCalendar | 删除日历 | 删除指定日历 |
| UpdateWorkflowDAG | 更新工作流的DAG信息 | 更新工作流的DAG信息，包含节点坐标和边信息 |
| OperateUnholdJobExecution | 取消挂起任务实例 | 将挂起状态的任务实例恢复执行 |
| OperateHoldWorkflowExecution | 挂起工作流实例 | 挂起工作流实例，会将工作流中还未执行的节点挂起 |
| OperateBackfillWorkflow | 回补工作流历史数据 | 回补工作流历史数据 |
| DeleteWorkflows | 批量删除工作流 | 批量删除工作流 |
| UpdateCalendar | 更新日历 | 更新日历 |
| OperateRetryWorkflowExecution | 重跑工作流实例 | 重跑工作流实例 |
| UpdateWorkflowDAGVersion | 切换工作流DAG版本 | 切换工作流DAG版本 |
| GetCalendar | 获取日历 | 获取日历 |
| GetWorkflowExecutionDAG | 获取工作流实例的DAG信息 | 获取工作流实例的DAG信息 |
| ListWorkflows | 获取工作流列表 | 获取工作流列表 |
| OperateMarkSuccessJobExecution | 标记任务实例为成功状态 | 标记任务实例为成功状态 |
| CreateWorkflow | 创建工作流 | 创建工作流 |
| OperateDisableWorkflows | 禁用工作流 | 禁用工作流 |
| OperateUnholdWorkflowExecution | 取消挂起工作流实例 | 将挂起状态的工作流实例恢复执行 |
| OperateExecuteWorkflow | 运行一次工作流 | 运行一次工作流 |
| OperateStopWorkflowExecution | 停止正在运行的工作流实例 | 停止正在运行的工作流实例 |
| ListCalendars | 获取日历列表 | 获取日历列表 |
| GetWorkflowDAGPreview | 获取工作流历史版本的DAG | 获取工作流历史版本的DAG |
| ListWorkflowExecutions | 获取工作流实例列表 | 获取工作流实例列表 |
| DeleteWorkflow | 删除工作流 | 删除工作流 |
该文章对您有帮助吗？