更新时间:2024-04-24 GMT+08:00
分享

获取流运行详细信息

功能介绍

根据流id和运行记录id查询流运行详细信息,包括流的Id、名称、图标、开始时间、结束时间、最后一步运行状态以及流步骤元数据。

接口约束

URI

GET /v2/{project_id}/flows/{flow_id}/running-history/{running_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id,用于资源隔离。获取方法请参考获取项目ID

flow_id

String

流id。

running_id

String

流运行记录id。

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

id

String

流运行记录id。

flow_id

String

流id。

flow_name

String

流名称。

run_model

String

流运行模式,通常有手动、自动、测试这几种。手动方式需要用户在页面点击运行流,自动方式会按照触发器的类型自动运行流,测试方式用户在创建流的时候可以测试流的功能。

status

String

最后一次运行,流运行状态。

  • success: 流运行成功

  • fail: 流运行失败

icon

String

流图标。

start_time

String

开始运行时间。

end_time

String

结束运行时间。

exec_time

Long

执行时间,单位毫秒。

message

String

最后一次运行,输出的错误信息。

steps

Array of steps objects

一个流通常由多个步骤组成,该数组是流每一步骤的元数据。

表3 steps

参数

参数类型

描述

stepId

String

操作步骤id。

name

String

连接器名字。

actionName

String

操作步骤名称。

actionType

String

操作步骤类型。

call

call object

连接器操作信息。

icon

String

步骤的图标。

transmit

Array of strings

该步骤执行完之后,下一步操作的ID列表。

mockOutput

String

模拟输出数据。

lastRunningStatus

String

流中该步骤的最后一次运行状态。

  • success: 流运行成功

  • fail: 流运行失败

cost

Long

执行此步骤的花费时间,单位毫秒。

表4 call

参数

参数类型

描述

connectorRef

String

连接器操作id。

triggerRef

triggerRef object

触发器操作定义。

actionRef

actionRef object

普通操作定义。

connectorVersion

String

连接器版本。

表5 triggerRef

参数

参数类型

描述

refName

String

触发器操作名称。

refId

String

触发器操作id。

type

String

触发器操作类型。

authentication

authentication object

连接器操作认证。

input

Map<String,Object>

连接器执行时的输入数据。

config

Map<String,Object>

连接器配置信息。

customFunctionIds

Array of strings

用户可以在流中使用自定义函数处理数据,该字段存储所有用户在该流中使用的自定义的函数id。

customFunctionMap

Map<String,Object>

自定义函数配置。

表6 authentication

参数

参数类型

描述

connectionId

String

连接器id。

schema

schema object

连接器认证元数据。

表7 schema

参数

参数类型

描述

id

String

连接id,流使用连接器时需要配置认证信息,称为连接。

authInfo

Map<String,Object>

连接认证信息。

connectorId

String

连接器id。

type

String

连接器类型。

表8 actionRef

参数

参数类型

描述

refName

String

普通操作名称。

refId

String

普通操作id。

type

String

普通操作类型。

authentication

authentication object

连接器操作认证。

input

Map<String,Object>

连接器执行时的输入数据。

config

Map<String,Object>

连接器配置信息。

customFunctionIds

Array of strings

用户可以在流中使用自定义函数处理数据,该字段存储所有用户在该流中使用的自定义的函数id。

customFunctionMap

Map<String,Object>

自定义函数配置。

表9 authentication

参数

参数类型

描述

connectionId

String

连接器id。

schema

schema object

连接器认证元数据。

表10 schema

参数

参数类型

描述

id

String

连接id。

authInfo

Map<String,Object>

连接认证信息。

connectorId

String

连接器id。

type

String

连接器类型。

状态码: 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:8

最大长度:36

error_msg

String

错误描述。

最小长度:2

最大长度:512

状态码: 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:8

最大长度:36

error_msg

String

错误描述。

最小长度:2

最大长度:512

请求示例

响应示例

状态码: 200

请求成功。

{
  "id" : "d96ba061-3caf-49cb-8950-4dac97a8f082",
  "flow_id" : "cfdcacae-a44f-4827-8ad9-db47ad2a8b41",
  "flow_name" : "遍历集合元素测试",
  "run_model" : "manual",
  "status" : "success",
  "icon" : "https://connector-icon.obs.cn-north-7.ulanqab.huawei.com/icon/c9710579264845c6a5339fd738e66fd6/155e6930bdb24d9d95b5d3c636e133eb.png",
  "start_time" : 1655881122470,
  "end_time" : 1655881126839,
  "exec_time" : 4369,
  "message" : null,
  "steps" : [ {
    "stepId" : "05778538-83a6-467b-bb92-738d9049bb3c",
    "actionName" : "手动触发器触发事件",
    "actionType" : null,
    "call" : {
      "connectorRef" : "ManualTrigger",
      "triggerRef" : {
        "refName" : "手动触发器触发事件",
        "refId" : "ManualTrigger",
        "type" : "instant",
        "authentication" : {
          "connectionId" : null,
          "schema" : null
        },
        "input" : {
          "body" : { }
        },
        "config" : null,
        "customFunctionMap" : null
      },
      "actionRef" : null,
      "connectorVersion" : "1"
    },
    "transmit" : [ "bc744b98-007f-496e-bd10-ed460548f7de" ],
    "icon" : "https://connector-icon.obs.cn-north-7.ulanqab.huawei.com/icon/c9710579264845c6a5339fd738e66fd6/155e6930bdb24d9d95b5d3c636e133eb.png",
    "name" : "手动触发流",
    "lastRunningStatus" : "success",
    "cost" : 354
  } ]
}

状态码

状态码

描述

200

请求成功。

403

权限不足。

500

系统异常。

错误码

请参见错误码

相关文档