本產(chǎn)品（
云工作流/2019-03-15）的OpenAPI采用RPC簽名風(fēng)格，簽名細(xì)節(jié)參見(jiàn)簽名機(jī)制說(shuō)明。我們已經(jīng)為開(kāi)發(fā)者封裝了常見(jiàn)編程語(yǔ)言的SDK，開(kāi)發(fā)者可通過(guò)下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無(wú)需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿(mǎn)足使用需求，可通過(guò)簽名機(jī)制進(jìn)行自簽名對(duì)接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費(fèi) 5個(gè)工作日左右。因此建議加入我們的服務(wù)釘釘群（11370001915），在專(zhuān)家指導(dǎo)下進(jìn)行簽名對(duì)接。在使用API前，您需要準(zhǔn)備好身份賬號(hào)及訪問(wèn)密鑰（AccessKey），才能有效通過(guò)客戶(hù)端工具（SDK、CLI等）訪問(wèn)API。細(xì)節(jié)請(qǐng)參見(jiàn)獲取AccessKey。
流程
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateFlow | 創(chuàng)建一個(gè)流程 | 創(chuàng)建一個(gè)流程。 |
| DeleteFlow | 刪除一個(gè)已存在的流程 | 刪除一個(gè)已存在的流程。 |
| UpdateFlow | 更新一個(gè)已有流程 | 更新一個(gè)流程的內(nèi)容。 |
| DescribeFlow | 獲取一個(gè)流程的相關(guān)信息 | 獲取一個(gè)流程的相關(guān)信息。 |
| ListFlows | 批量查詢(xún)流程信息 | 批量查詢(xún)流程信息。 |
執(zhí)行
| API | 標(biāo)題 | API概述 |
|---|---|---|
| StartExecution | 異步調(diào)用開(kāi)始一個(gè)流程的執(zhí)行 | 開(kāi)始一個(gè)流程的執(zhí)行。 |
| StopExecution | 停止一個(gè)正在執(zhí)行的流程 | 停止一個(gè)正在執(zhí)行的流程。 |
| DescribeExecution | 獲取一次執(zhí)行的狀態(tài)信息 | 獲取一次執(zhí)行的狀態(tài)信息，支持長(zhǎng)輪詢(xún)模式，長(zhǎng)輪詢(xún)最長(zhǎng)等待時(shí)間由 WaitTimeSeconds 參數(shù)指定。 |
| ListExecutions | 獲取一個(gè)流程的歷史執(zhí)行 | 獲取一個(gè)流程的所有歷史執(zhí)行。 |
| GetExecutionHistory | 獲取一次執(zhí)行的步驟詳情 | 獲取指定執(zhí)行過(guò)程中的每個(gè)步驟詳細(xì)信息。 |
| StartSyncExecution | 同步調(diào)用開(kāi)始一個(gè)流程的執(zhí)行 | 同步調(diào)用開(kāi)始一個(gè)流程的執(zhí)行。 |
任務(wù)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ReportTaskFailed | 匯報(bào)指定的任務(wù)執(zhí)行失敗 | 匯報(bào)指定的任務(wù)執(zhí)行失敗。 |
| ReportTaskSucceeded | 匯報(bào)指定的任務(wù)執(zhí)行成功 | 匯報(bào)指定的任務(wù)執(zhí)行成功。 |
定時(shí)調(diào)度
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateSchedule | 創(chuàng)建一個(gè)定時(shí)調(diào)度 | 創(chuàng)建一個(gè)定時(shí)調(diào)度。 |
| DeleteSchedule | 刪除一個(gè)定時(shí)調(diào)度 | 刪除一個(gè)定時(shí)調(diào)度。 |
| UpdateSchedule | 更新一個(gè)定時(shí)調(diào)度 | 更新一個(gè)定時(shí)調(diào)度。 |
| DescribeSchedule | 獲取一個(gè)定時(shí)調(diào)度 | 獲取一個(gè)定時(shí)調(diào)度信息。 |
| ListSchedules | 獲取定時(shí)調(diào)度列表 | 獲取定時(shí)調(diào)度列表。 |