API标准及多语言预置SDK
本产品（任务调度SchedulerX/2019-04-30）的 OpenAPI 采用 RPC 签名机制，具体签名方式请参见签名机制说明。我们已为开发者封装了主流编程语言的 SDK，您可通过 下载 SDK 快速调用 API，无需关注签名等底层实现细节，显著降低开发门槛与集成复杂度。自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
服务地域
| API | 标题 | API概述 |
|---|---|---|
| DescribeRegions | 查看可选的地域 | 返回可用region列表。 |
命名空间
| API | 标题 | API概述 |
|---|---|---|
| CreateNamespace | 创建命名空间 | 创建命名空间。 |
| ListNamespaces | 获取命名空间列表 | 获取命名空间列表。 |
| DeleteNamespace | 删除命名空间 | 删除命名空间。 |
| UpdateNamespace | 更新命名空间 | 更新命名空间。 |
应用分组
| API | 标题 | API概述 |
|---|---|---|
| CreateAppGroup | 创建应用分组 | 创建应用分组，返回appKey。 |
| GetAppGroup | 获取应用分组详情 | 获取应用分组。 |
| DeleteAppGroup | 删除应用分组 | 删除应用分组。 |
| UpdateAppGroup | 更新应用分组 | 更新应用分组。 |
| ListGroups | 获取应用分组列表 | 获取应用列表。 |
| GetWorkerList | 获取接入某个应用的worker列表 | 获取接入某个应用的worker列表。 |
工作流
| API | 标题 | API概述 |
|---|---|---|
| CreateWorkflow | 创建工作流 | 创建工作流，默认禁用状态，更新完DAG后，需要手动或者通过API启动用工作流，只有专业版才支持。 |
| UpdateWorkflow | 更新工作流的基本信息 | 更新工作流的基本信息，只有专业版才支持。 |
| UpdateWorkflowDag | 更新工作流的DAG | 更新工作流的节点及依赖关系，专业版应用才支持。 |
| ListWorkFlows | 获取工作流信息列表 | 获取工作流信息列表。 |
| ExecuteWorkflow | 触发一次工作流 | 触发一次工作流立即运行。 |
| DeleteWorkflow | 删除指定工作流 | 删除指定工作流。 |
| DisableWorkflow | 禁用指定工作流 | 禁用指定工作流。 |
| EnableWorkflow | 启用指定工作流 | 启用指定工作流。 |
| GetWorkFlow | 获取工作流详情和依赖关系 | 获取工作流信息。 |
| GetWorkflowInstance | 获取工作流实例详情及DAG | 获取指定工作流实例的详情，包含实例状态，依赖关系，每个任务实例的状态等。专业版应用才支持。 |
| ListWorkflowInstance | 获取工作流实例列表 | 获取工作流的历史执行记录，只有专业版才支持。 |
| SetWfInstanceSuccess | 标记工作流实例成功 | 强制设置工作流实例状态为成功状态，只有专业版才支持。 |
任务
| API | 标题 | API概述 |
|---|---|---|
| CreateJob | 创建任务并返回任务ID | 创建任务并返回任务ID。 |
| DeleteJob | 删除指定任务 | 删除指定任务。 |
| BatchDeleteJobs | 批量删除任务 | 批量删除任务。 |
| UpdateJob | 更新任务配置信息 | 更新任务配置信息。默认先调用获取任务找到对应字段进行修改。 |
| DisableJob | 停用指定任务 | 停用指定任务。 |
| BatchEnableJobs | 批量启用任务 | 批量启用任务。 |
| BatchDisableJobs | 批量禁用任务 | 批量禁用任务。 |
| EnableJob | 启用指定任务 | 启用指定任务。 |
| GetJobInfo | 获取指定Jobid任务详情 | 获取指定Jobid任务详情，通常用来更新任务。 |
| ListJobs | 获取任务列表 | 获取任务列表。 |
| ExecuteJob | 触发一次任务 | 触发一次任务立即运行。 |
| DesignateWorkers | 指定机器 | 指定机器。 |
| RerunJob | 重刷任务的历史数据 | 重跑任务的历史数据，只有专业版才支持。 |
| UpdateJobScript | 更新任务执行脚本 | 更新任务执行脚本。 |
| ListJobScriptHistory | 获取任务脚本历史列表 | 获取任务脚本历史列表。 |
| ReadSchedulerxDesignateInfo | 获取任务指定的机器基本信息 | 获取指定的机器基本信息。 |
| ReadSchedulerxDesignateDetail | 获取任务指定的机器详细信息 | 获取任务指定的机器详细信息。 |
| ManageSchedulerxJobSync | 跨命名空间同步任务 | 跨命名空间同步任务。 |
任务实例
| API | 标题 | API概述 |
|---|---|---|
| StopInstance | 终止正在运行的实例 | 终止某次正在运行的实例。 |
| GetJobInstance | 获取指定任务实例详情 | 返回任务实例的信息，可以查看任务实例的状态和进度。 |
| GetJobInstanceList | 获取指定任务ID的执行实例列表 | 根据关键字过滤，返回任务执行的历史记录。 |
| RetryJobInstance | 重跑任务实例 | 重跑失败或者成功状态的任务实例，只有专业版才支持。 |
| SetJobInstanceSuccess | 标记任务实例成功 | 强制设置任务实例状态为成功状态，只有专业版才支持。 |
权限设置
| API | 标题 | API概述 |
|---|---|---|
| GrantPermission | 给指定分组授权 | 给指定分组授权。 |
| RevokePermission | 取消指定阿里云子账号的权限 | 取消指定阿里云子账号的权限。 |
日志
| API | 标题 | API概述 |
|---|---|---|
| GetLog | 查询日志 | 通过该API可以查询任务的运行日志，需要开通专业版才支持。 |
路由策略
| API | 标题 | API概述 |
|---|---|---|
| DeleteRouteStrategy | 删除路由策略 | 删除路由策略。 |
| BatchDeleteRouteStrategy | 批量删除路由策略 | 批量删除路由策略。 |
| CreateRouteStrategy | 创建路由策略 | 创建路由策略。 |
通知策略
| API | 标题 | API概述 |
|---|---|---|
| CreateSchedulerxNotificationPolicy | 创建通知策略 | 创建通知策略。 |
| DeleteSchedulerxNotificationPolicy | 删除通知策略 | 删除通知策略。 |
| ManageSchedulerxNotificationPolicy | 更新通知策略 | 更新通知策略。 |
| ReadSchedulerxNotificationPolicy | 查询通知策略 | 查询通知策略。 |
日历
| API | 标题 | API概述 |
|---|---|---|
| CreateSchedulerxCalendar | 创建日历 | 创建日历。 |
| DeleteSchedulerxCalendar | 删除日历 | 删除日历。 |
| ManageSchedulerxCalendar | 更新日历 | 更新日历。 |
| ReadSchedulerxCalendar | 查询日历 | 查询日历。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| GetOverview | 获取概览数据信息 | 获取专业版应用任务调度概览数据信息。 |