更新时间:2024-12-06 GMT+08:00

回调工作流

功能介绍

回调工作流

URI

POST /v2/{project_id}/fgs/workflows/{workflow_id}/callback

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

最小长度:1

最大长度:64

workflow_id

String

工作流定义ID

最小长度:1

最大长度:512

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workflow-Run-Id

String

workflow run id

X-Workflow-State-Id

String

workflow state id

表3 请求Body参数

参数

是否必选

参数类型

描述

result

String

执行结果

最小长度:1

最大长度:64

枚举值:

  • success
  • fail

error

String

错误信息

最小长度:1

最大长度:64

output

Object

工作流的执行结果,JSON格式,仅在status为success时有值

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

execution_id

String

错误码

最小长度:1

最大长度:64

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

回调工作流

POST /v2/{project_id}/fgs/workflows/{workflow_id}/callback
{
  "result": "success",
  "output": {}
}

响应示例

状态码: 200

Success

{
  "execution_id" : "48aff955-ea10-4ffd-b426-190bc192dc13"
}

状态码

状态码

描述

200

Success

400

Bad Request

404

Bad Request

500

Internal Server Error

错误码

请参见错误码