数据工坊API中查询工作流实例列表的具体用途是什么-ListWorkflowInstance接口

教程大全 2026-02-23 14:26:57 浏览次

ListWorkflowInstance——执行工作流，数据工坊API详解

ListWorkflowInstance接口是数据工坊API中用于查询用户工作流实例列表的关键接口,通过调用该接口，用户可以获取到指定工作流的实例列表，包括实例的状态、创建时间、执行时间等信息，本文将详细介绍该接口的使用方法、参数说明以及注意事项。

接口使用方法

请求方式

ListWorkflowInstance接口支持GET请求。

请求url

接口的请求URL格式如下：

{workflowId}/instances

{workflowId} 为工作流的唯一标识符。

请求参数

请求示例

GET接口返回结果

返回格式

ListWorkflowInstance接口返回JSON格式数据。

返回字段

返回示例


{"code": 200,"message": "请求成功","data": {"instances": [{"id": "67890","status": "active","createTime": "2025-01-01T00:00:00Z","executeTime": "2025-01-01T01:00:00Z"},{"id": "123456","status": "completed","createTime": "2025-01-02T00:00:00Z","executeTime": "2025-01-02T02:00:00Z"}]}}
注意事项

相关问答FAQs

Q1：如何获取所有状态的工作流实例？

A1：在调用ListWorkflowInstance接口时，不传入参数，即可获取所有状态的工作流实例。

Q2：如何根据实例状态筛选工作流实例？

A2：在调用ListWorkflowInstance接口时，通过传入参数，可以筛选指定状态的工作流实例，传入status=active，即可获取所有活跃状态的工作流实例。