文档

API概览

更新时间:
一键部署
本产品(任务调度SchedulerX/2019-04-30)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

服务地域

API标题API概述
DescribeRegions查看可选的地域返回可用region列表。

命名空间

API标题API概述
CreateNamespace创建命名空间创建命名空间。
ListNamespaces获取命名空间列表获取命名空间列表。

应用分组

API标题API概述
CreateAppGroup创建应用分组创建应用分组,返回appKey。
GetAppGroup获取应用分组详情获取应用分组。
DeleteAppGroup删除应用分组删除应用分组。
UpdateAppGroup更新应用分组更新应用分组。
ListGroups获取应用分组列表获取应用列表。
GetWorkerList获取接入某个应用的worker列表获取接入某个应用的worker列表。

工作流

API标题API概述
CreateWorkflow创建工作流创建工作流,默认禁用状态,更新完DAG后,需要手动或者通过API启动用工作流,只有专业版才支持。
UpdateWorkflow更新工作流的基本信息更新工作流的基本信息,只有专业版才支持。
UpdateWorkflowDag更新工作流的DAG更新工作流的节点及依赖关系,专业版应用才支持。
DeleteWorkflow删除指定工作流删除指定工作流。
DisableWorkflow禁用指定工作流禁用指定工作流。
EnableWorkflow启用指定工作流启用指定工作流。
GetWorkFlow获取工作流详情和依赖关系获取工作流信息。
ExecuteWorkflow触发一次工作流触发一次工作流立即运行。
GetWorkflowInstance获取工作流实例详情及DAG获取指定工作流实例的详情,包含实例状态,依赖关系,每个任务实例的状态等。专业版应用才支持。
ListWorkflowInstance获取工作流实例列表获取工作流的历史执行记录,只有专业版才支持。
SetWfInstanceSuccess标记工作流实例成功强制设置工作流实例状态为成功状态,只有专业版才支持。

任务

API标题API概述
CreateJob创建任务并返回任务ID创建任务并返回任务ID。
DeleteJob删除指定任务删除指定任务。
BatchDeleteJobs批量删除任务批量删除任务。
UpdateJob更新任务配置信息更新任务配置信息。默认先调用获取任务找到对应字段进行修改。
DisableJob停用指定任务停用指定任务。
BatchEnableJobs批量启用任务批量启用任务。
BatchDisableJobs批量禁用任务批量禁用任务。
EnableJob启用指定任务启用指定任务。
GetJobInfo获取指定Jobid任务详情获取指定Jobid任务详情,通常用来更新任务。
ListJobs获取任务列表获取任务列表。
ExecuteJob触发一次任务触发一次任务立即运行。
DesignateWorkers指定机器指定机器。
RerunJob重刷任务的历史数据重跑任务的历史数据,只有专业版才支持。

任务实例

API标题API概述
StopInstance终止正在运行的实例终止某次正在运行的实例。
GetJobInstance获取指定任务实例详情返回任务实例的信息,可以查看任务实例的状态和进度。
GetJobInstanceList获取指定任务ID的执行实例列表根据关键字过滤,返回任务执行的历史记录。
RetryJobInstance重跑任务实例重跑失败或者成功状态的任务实例,只有专业版才支持。
SetJobInstanceSuccess标记任务实例成功强制设置任务实例状态为成功状态,只有专业版才支持。

权限设置

API标题API概述
GrantPermission给指定分组授权给指定分组授权。
RevokePermission取消指定阿里云子账号的权限取消指定阿里云子账号的权限。

日志

API标题API概述
GetLog查询日志通过该API可以查询任务的运行日志,需要开通专业版才支持。

路由策略

API标题API概述
DeleteRouteStrategy删除路由策略删除路由策略。
BatchDeleteRouteStrategy批量删除路由策略批量删除路由策略。
CreateRouteStrategy创建路由策略创建路由策略。

其他

API标题API概述
GetOverview获取概览数据信息获取专业版应用任务调度概览数据信息。