API概览_云工作流(CloudFlow)-阿里云帮助中心

本产品（fnf/2019-03-15）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

地域

API	标题	API概述
DescribeRegions	查询地域信息	查询云工作流产品支持的地域信息。

流程

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	获取定时调度列表（仅适用于旧版工作流）	获取定时调度列表。