文档首页/ 开天集成工作台 MSSI/ API参考/ API/ 流管理/ 查询单个流运行历史记录
更新时间：2024-04-24 GMT+08:00
查看PDF
分享

查询单个流运行历史记录

功能介绍

根据单个流id查询该流的所有运行历史记录。

接口约束

无

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

flow_id

是

String

流id。
表2 Query参数

参数

是否必选

参数类型

描述

time_range

否

String

时间筛选范围，查询该范围内的流运行记录。UTC时间格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'toyyyy-MM-dd'T'HH:mm:ss.SSS'Z'如：2020-11-10T00:00:00Zto2020-11-12T00:00:00。

status

否

String

流运行状态，枚举值。

  • success: 流运行成功

  • fail: 流运行失败

offset

否

Integer

当前页，起始页数应大于等于0。

最小值：1

limit

否

Integer

每页记录数，每页记录数应大于等于1。

最小值：1

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total

Long

历史记录总数。

histories

Array of histories objects

所有历史记录的信息。
表4 histories

参数

参数类型

描述

id

String

流运行记录ID。

flow_id

String

流ID。

flow_name

String

流名称。

flow_version_id

String

流运行版本ID。

run_model

String

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

status

String

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

  • success: 流运行成功

  • fail: 流运行失败

icon

String

流图标。

start_time

String

开始时间。

end_time

String

结束时间。

exec_time

Long

执行时间，单位毫秒。

running_times

Long

运行次数。

last_time

String

最后一次运行时间。

message

String

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

状态码： 403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

请求示例

无

响应示例

状态码： 200

请求成功。

{
  "count" : 1438,
  "histories" : [ {
    "id" : "df00b54a-7765-4ed9-98fe-1504119841e4",
    "flow_id" : "55e42ede-25dd-4f79-9aa4-842e1ba435a1",
    "flow_name" : "业务对象测试",
    "flow_version_id" : "55e42ede-25dd-4f79-9aa4-842e1ba435a1",
    "run_model" : "auto",
    "status" : "fail",
    "icon" : null,
    "start_time" : "2022-02-28T06:24:04.022Z",
    "end_time" : "2022-02-28T06:24:04.022Z",
    "exec_time" : 0,
    "running_times" : null,
    "last_time" : null,
    "message" : "trigger action running fail."
  } ]
}

状态码

状态码

描述

200

请求成功。

403

权限不足。

500

系统异常。

错误码

请参见错误码。

父主题： 流管理

相关文档