任务和工作流元数据

端点 描述 输入
GET /metadata/taskdefs 获取所有任务定义 N / A
GET /metadata/taskdefs/{taskType} 检索任务定义 任务名称
POST /metadata/taskdefs 注册新任务定义 任务清单清单
PUT /metadata/taskdefs 更新任务定义 一个任务定义
DELETE /metadata/taskdefs/{taskType} 删除任务定义 任务名称
     
GET /metadata/workflow 获取所有工作流定义 N / A
POST /metadata/workflow 注册新工作流程 工作流定义
PUT /metadata/workflow 注册/更新新工作流程 工作流定义列表
GET /metadata/workflow/{name}?version= 获取工作流定义 工作流名称,版本(可选)
     

启动一个工作流

仅使用输入

POST /workflow/{name}?version=&correlationId=
{
//JSON payload for workflow
}
参数 描述
可选的。如果未指定使用最新版本的工作流程
的correlationID 用户提供的可用于检索工作流的Id

输入

JSON有效载荷启动工作流。强制性。如果工作流不期望任何输入必须传递一个空的JSON{}

产量

工作流ID(GUID)

使用输入和任务域

POST /workflow
{
//JSON payload for Start workflow request
}

启动工作流程请求

JSON用于启动工作流请求

{
"name": "myWorkflow", // Name of the workflow
"version": 1, // Version
“correlatond”: “corr1” // correlation Id
"input": {
// Input map.
},
"taskToDomain": {
// Task to domain map
}
}

产量

工作流ID(GUID)

检索工作流程

端点 描述
GET /workflow/{workflowId}?includeTasks=true|false 通过工作流标识获取工作流状态。如果设置了includeTasks,那么还包括执行和调度的所有任务。
GET /workflow/running/{name} 获取给定类型的所有正在运行的工作流
GET /workflow/running/{name}/correlated/{correlationId}?includeClosed=true|false&includeTasks=true|false 获取所有正在运行的关联标识过滤的工作流。如果includeClosed被设置,还包括完成运行的工作流。
GET /workflow/search 搜索工作流。见下文。
   

搜索工作流程

指挥机构使用Elasticsearch对工作流执行进行索引,并被搜索API使用。

GET /workflow/search?start=&size=&sort=&freeText=&query=

参数 描述
开始 页码。默认为0
尺寸 要返回的结果数
分类 排序。格式是:ASC:<fieldname>DESC:<fieldname>按字段按升序或降序排序
FREETEXT Elasticsearch支持查询。例如workflowType:“name_of_workflow”
询问 SQL like where子句。例如workflowType ='name_of_workflow'。如果提供了freeText,则为可选项。

产量

搜索结果如下所示:

{
"totalHits": 0,
"results": [
{
"workflowType": "string",
"version": 0,
"workflowId": "string",
"correlationId": "string",
"startTime": "string",
"updateTime": "string",
"endTime": "string",
"status": "RUNNING",
"input": "string",
"output": "string",
"reasonForIncompletion": "string",
"executionTime": 0,
"event": "string"
}
]
}

管理工作流程

端点 描述
PUT /workflow/{workflowId}/pause 暂停。将不再安排进一步的工作,直到恢复。当前正在运行的任务不会暂停。
PUT /workflow/{workflowId}/resume 暂停后恢复正常操作。
POST /workflow/{workflowId}/rerun 见下文。
POST /workflow/{workflowId}/restart 从一开始重新启动工作流执行。当前执行历史被擦除。
POST /workflow/{workflowId}/retry 重试最后一个失败的任务。
PUT /workflow/{workflowId}/skiptask/{taskReferenceName} 见下文。
DELETE /workflow/{workflowId} 终止正在运行的工作流。
DELETE /workflow/{workflowId}/remove 从系统中删除工作流。谨慎使用。

重新运行

从特定任务重新运行完成的工作流。

POST /workflow/{workflowId}/rerun

{
"reRunFromWorkflowId": "string",
"workflowInput": {},
"reRunFromTaskId": "string",
"taskInput": {}
}

跳过任务

taskReferenceName在运行的工作流程中跳过任务执行(指定为参数),并继续前进。可选地更新任务的输入和输出,如有效载荷中指定的。 PUT /workflow/{workflowId}/skiptask/{taskReferenceName}?workflowId=&taskReferenceName=

{
"taskInput": {},
"taskOutput": {}
}

管理任务

端点 描述
GET /tasks/{taskId} 获取任务详情。
GET /tasks/queue/all 列出待处理的任务大小。
GET /tasks/queue/all/verbose 与上述相同,包括每个分片的大小
GET /tasks/queue/sizes?taskType=&taskType=&taskType 返回给定任务类型的待处理任务的大小
   

轮询,确认和更新任务

这些是用于轮询任务的关键端点,发送ack(轮询后),最后由工作人员更新任务结果。

端点 描述
GET /tasks/poll/{taskType}?workerid=&domain= 投票任务 workerid标识为作业轮询的工作者,并domain允许轮询器轮询特定域中的任务
GET /tasks/poll/batch/{taskType}?count=&timeout=&workerid=&domain 对由指定的批次中的任务进行轮询count。这是一个长时间的轮询,连接将等到timeout或至少有1个可用项目(以较先者为准)。workerid标识为作业轮询的工作者,并domain允许轮询器轮询特定域中的任务
POST /tasks 更新任务执行的结果。请参阅下面的模式。
POST /tasks/{taskId}/ack 承认工作人员投票后收到的任务。

更新任务结果的模式

{
"workflowInstanceId": "Workflow Instance Id",
"taskId": "ID of the task to be updated",
"reasonForIncompletion" : "If failed, reason for failure",
"callbackAfterSeconds": 0,
"status": "IN_PROGRESS|FAILED|COMPLETED",
"outputData": {
//JSON document representing Task execution output
} }

轮询后承认任务

如果工作人员在轮询后无法确认任务,则重新排队任务并将其放回队列中,并在后续轮询中可用。

获取running的workflow
curl -X GET --header 'Accept: application/json' 'http://192.168.9.137:8080/api/workflow/running/<name>?version=1'
终止workflow
curl -X DELETE --header 'Accept: application/json' 'http://192.168.9.137:8080/api/workflow/<workflowId>'

启动workflow

curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/plain' -d '{}' 'http://localhost:8080/api/workflow/<name>'

conductor APIs的更多相关文章

  1. (转载)构建public APIs与CORS

    from: https://segmentfault.com/a/1190000000709909 理由:在操作层面详细的讲解了跨域的操作.尤其是对于option请求的详解.收藏. 在构建Public ...

  2. ECMAScript Web APIs node.js

    https://hacks.mozilla.org/2015/04/es6-in-depth-an-introduction/ What falls under the scope of ECMASc ...

  3. 【墙内备份】Android 6.0 APIs

    Android 6.0 APIs In this documentSHOW MORE Fingerprint Authentication Confirm Credential App Linking ...

  4. netflix:Conductor微服务编排引擎

    项目地址: https://github.com/Netflix/conductor Conductor 是 Netflix 受需要运行全球流媒体业务流程的启发,构建的基于云的微服务编排引擎. Con ...

  5. swagger:The World's Most Popular Framework for APIs.

    swagger官网:http://swagger.io/ swagger ui demo:http://petstore.swagger.io 让API文档总是与API定义同步更新,是一件非常有价值的 ...

  6. [译]Node.js : Building RESTful APIs using Loopback and MySQL

    国庆后可能就要使用StrongLoop那套东西来做项目了 原文:http://www.javabeat.net/loopback-mysql/ Loopback是什么? Loopback是一个开源的N ...

  7. URLRedirector 解决网页上无法访问 google CDN 的问题(fonts、ajax、themes、apis等)

    URLRedirector 解决网页上无法访问 google CDN 的问题(fonts.ajax.themes.apis等) 由于某些原因,在访问国外的网站时有时候会特别慢,像 stackoverf ...

  8. 谷歌正式发布Google APIs Client Library for .NET

    好消息,特大好消息! 英文原文:Google API library for .NET paves the way for Google services on Windows phone 本月 17 ...

  9. POSTMAN and HTTPie to test APIs

    http://blog.mashape.com/postman-httpie-test-apis/ We love working with APIs at Mashape, and we love ...

随机推荐

  1. 全选,反选,获取值ajax提交

    //必须先加载jquery //加载 弹出框插件 artdialog http://www.planeart.cn/demo/artDialog/ /****全选反选*开始**/ $(document ...

  2. vue 感觉很好的渲染模式

    <ul v-if="todos.length"> <li v-for="todo in todos"> {{ todo }} </ ...

  3. 服务注册发现Eureka之二:高可用服务注册中心

    前言 在Spring Cloud系列文章的开始,我们就介绍了服务注册与发现,其中,主要演示了如何构建和启动服务注册中心Eureka Server,以及如何将服务注册到Eureka Server中,但是 ...

  4. HTML5: input:file上传类型控制

    ylbtech-HTML5: input:file上传类型控制   1. 一.input:file 属性返回顶部 一.input:file属性 属性值有以下几个比较常用: accept:表示可以选择的 ...

  5. js实现手机号身份证等加星(*)号

    下面来为各位整理了一些关于js实现手机号身份证等加星(*)号代码了,在js不足时我们还补充了php实现手机号身份证等加星(*)号的函数,有兴趣的一起来看看.   有时候为了不让用户的手机号码和身份证号 ...

  6. Game of War - Fire Age 有何特别之处?

    作者:福克斯007 链接:https://www.zhihu.com/question/21611550/answer/52458767来源:知乎著作权归作者所有.商业转载请联系作者获得授权,非商业转 ...

  7. 关于input=file的用法

    <input type="file"/>这个东西是用来上传图片用的. 1,但是存在一下问题但是在在各个浏览器下的显示是不一样的 IE下: IE之外的浏览器: 2.如果不 ...

  8. Web API 源码剖析之默认消息处理程序链之路由分发器(HttpRoutingDispatcher)

    Web API 源码剖析之默认消息处理程序链-->路由分发器(HttpRoutingDispatcher) 我们在上一节讲述了默认的DefaultServer(是一个类型为HttpServer的 ...

  9. Hive基础之Hive的存储类型

    Hive常用的存储类型有: 1.TextFile: Hive默认的存储类型:文件大占用空间大,未压缩,查询慢: 2.Sequence File:将属于以<KEY,VALUE>的形式序列化到 ...

  10. 小朋友学C语言(8)

    求圆周率 (一)圆周率简介 圆周率(Pi)是圆的周长与直径的比值,一般用希腊字母π表示,是一个在数学及物理学中普遍存在的数学常数.π也等于圆形之面积与半径平方之比.是精确计算圆周长.圆面积.球体积等几 ...