文档

ListWorkflowInstance - 获取工作流实例列表

更新时间:
一键部署

获取工作流的历史执行记录,只有专业版才支持。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID

cn-hangzhou
Namespacestring

命名空间ID,在控制台的命名空间页面中获取

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestring

特殊第三方才需要填写

schedulerx
GroupIdstring

应用分组ID,在控制台的应用管理页面中获取

testSchedulerx.defaultGroup
WorkflowIdstring

工作流ID

123

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求唯一ID

39090022-1F3B-4797-8518-6B61095F1AF0
Codeinteger

返回码

200
Successboolean

API执行是否成功。取值如下:

  • true:成功。
  • false:失败。
true
Messagestring

错误信息

workflowId=xxx is not existed
Dataobject

工作流实例列表封装在data里

WfInstanceInfosarray

工作流实例的列表

object

工作流实例数据结构

WfInstanceIdlong

工作流实例ID

123456
WorkflowIdlong

工作流ID

123
Statusinteger

工作流实例状态,取值如下:

  • 1: 等待中
  • 2: 准备中
  • 3:运行中
  • 4:成功
  • 5:失败
5
StartTimestring

开始时间

2023-01-03 18:00:01
EndTimestring

结束时间

2023-01-03 18:00:21
ScheduleTimestring

计划调度时间

2023-01-03 18:00:00
DataTimestring

数据时间

2023-01-03 18:00:00

示例

正常返回示例

JSON格式

{
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": 200,
  "Success": true,
  "Message": "workflowId=xxx is not existed",
  "Data": {
    "WfInstanceInfos": [
      {
        "WfInstanceId": 123456,
        "WorkflowId": 123,
        "Status": 5,
        "StartTime": "2023-01-03 18:00:01",
        "EndTime": "2023-01-03 18:00:21",
        "ScheduleTime": "2023-01-03 18:00:00",
        "DataTime": "2023-01-03 18:00:00"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)