華為云計(jì)算 云知識(shí) 同步執(zhí)行函數(shù)流StartSyncWorkflowExecution
同步執(zhí)行函數(shù)流StartSyncWorkflowExecution

 

功能介紹

以同步執(zhí)行方式啟動(dòng)工作流(僅快速模式工作流支持),暫不支持國(guó)際站局點(diǎn)調(diào)用

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

POST /v2/{project_id}/fgs/workflows/{workflow_id}/sync-executions

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID,獲取方式請(qǐng)參見(jiàn)獲取項(xiàng)目ID。

最小長(zhǎng)度:1

最大長(zhǎng)度:64

workflow_id

String

工作流定義ID

最小長(zhǎng)度:1

最大長(zhǎng)度:512

請(qǐng)求參數(shù)

表2 請(qǐng)求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

headers

Object

執(zhí)行時(shí)需要的Header

input

Object

定義執(zhí)行時(shí)的入?yún)?,支持使用JSONPATH進(jìn)行映射,以及指定默認(rèn)值

響應(yīng)參數(shù)

狀態(tài)碼: 200

表3 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

execution_id

String

流程實(shí)例ID

最小長(zhǎng)度:1

最大長(zhǎng)度:64

status

String

流程執(zhí)行最終狀態(tài)

最小長(zhǎng)度:1

最大長(zhǎng)度:64

枚舉值:

  • success

  • fail

  • timeout

output

Object

工作流的執(zhí)行結(jié)果,JSON格式,僅在status為success時(shí)有值

errors

Array of SyncExecutionNodeErrorDetail objects

流程執(zhí)行錯(cuò)誤信息,僅在status為fail時(shí)有值

begin_time

String

流程實(shí)例創(chuàng)建時(shí)間,格式:yyyy-MM-ddTHH:mm:ssZ,UTC時(shí)間

最小長(zhǎng)度:0

最大長(zhǎng)度:64

end_time

String

流程實(shí)例結(jié)束時(shí)間,格式:yyyy-MM-ddTHH:mm:ssZ,UTC時(shí)間

最小長(zhǎng)度:0

最大長(zhǎng)度:64

表4 SyncExecutionNodeErrorDetail

參數(shù)

參數(shù)類型

描述

node_id

String

流程節(jié)點(diǎn)ID

最小長(zhǎng)度:1

最大長(zhǎng)度:64

error_message

String

錯(cuò)誤詳細(xì)信息

最小長(zhǎng)度:1

最大長(zhǎng)度:2048

begin_time

String

流程實(shí)例創(chuàng)建時(shí)間,格式:yyyy-MM-ddTHH:mm:ssZ,UTC時(shí)間

最小長(zhǎng)度:0

最大長(zhǎng)度:64

end_time

String

流程實(shí)例結(jié)束時(shí)間,格式:yyyy-MM-ddTHH:mm:ssZ,UTC時(shí)間

最小長(zhǎng)度:0

最大長(zhǎng)度:64

狀態(tài)碼: 400

表5 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error_code

String

錯(cuò)誤碼

最小長(zhǎng)度:1

最大長(zhǎng)度:36

error_msg

String

錯(cuò)誤描述

最小長(zhǎng)度:2

最大長(zhǎng)度:512

狀態(tài)碼: 404

表6 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error_code

String

錯(cuò)誤碼

最小長(zhǎng)度:1

最大長(zhǎng)度:36

error_msg

String

錯(cuò)誤描述

最小長(zhǎng)度:2

最大長(zhǎng)度:512

狀態(tài)碼: 500

表7 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error_code

String

錯(cuò)誤碼

最小長(zhǎng)度:1

最大長(zhǎng)度:36

error_msg

String

錯(cuò)誤描述

最小長(zhǎng)度:2

最大長(zhǎng)度:512

請(qǐng)求示例

同步執(zhí)行工作流。

POST /{project_id}/fgs/workflows/{workflow_id}/sync-executions

{
  "headers" : {
    "tenantId" : "user1"
  },
  "input" : {
    "arg1" : "argument_1",
    "arg2" : "argument_2"
  }
}

響應(yīng)示例

狀態(tài)碼: 200

Success

{
  "execution_id" : "48aff955-ea10-4ffd-b426-190bc192dc14",
  "status" : "success",
  "output" : {
    "result" : 200,
    "message" : "success"
  },
  "errors" : [ {
    "node_id" : "48aff955-ea10-4ffd-b426-190bc192dc14",
    "error_message" : "Exception happened",
    "begin_time" : "2021-01-01T00:00:00Z",
    "end_time" : "2021-01-01T00:00:00Z"
  } ],
  "begin_time" : "2021-01-01T00:00:00Z",
  "end_time" : "2021-01-01T00:00:00Z"
}

狀態(tài)碼

狀態(tài)碼

描述

200

Success

400

Bad Request

404

Bad Request

500

Internal Server Error

錯(cuò)誤碼

請(qǐng)參見(jiàn)錯(cuò)誤碼