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

流程

API标题API概述
CreateFlow创建一个流程创建一个流程。
DeleteFlow删除一个已存在的流程删除一个已存在的流程。
UpdateFlow更新一个已有流程更新一个流程的内容。
DescribeFlow获取一个流程的相关信息获取一个流程的相关信息。
ListFlows批量查询流程信息批量查询流程信息。

执行

API标题API概述
StartExecution异步调用开始一个流程的执行开始一个流程的执行。
StopExecution停止一个正在执行的流程停止一个正在执行的流程。
DescribeExecution获取一次执行的状态信息获取一次执行的状态信息,支持长轮询模式,长轮询最长等待时间由 WaitTimeSeconds 参数指定。
ListExecutions获取一个流程的历史执行获取一个流程的所有历史执行。
GetExecutionHistory获取一次执行的步骤详情获取指定执行过程中的每个步骤详细信息。
StartSyncExecution同步调用开始一个流程的执行同步调用开始一个流程的执行。

任务

API标题API概述
ReportTaskFailed汇报指定的任务执行失败汇报指定的任务执行失败。
ReportTaskSucceeded汇报指定的任务执行成功汇报指定的任务执行成功。

定时调度

API标题API概述
CreateSchedule创建一个定时调度创建一个定时调度。
DeleteSchedule删除一个定时调度删除一个定时调度。
UpdateSchedule更新一个定时调度更新一个定时调度。
DescribeSchedule获取一个定时调度获取一个定时调度信息。
ListSchedules获取定时调度列表获取定时调度列表。