首页 > 代码库 > conductor APIs

conductor APIs

2024-10-06 09:24:02   216人阅读

任务和工作流元数据

端点描述输入
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     
    }

}

轮询后承认任务

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

conductor APIs


联系
我们