ListWorkflowInstances - 获取工作流实例列表

更新时间:2025-04-14 10:34

分页获取工作流实例列表,也可以通过条件进行筛选查询。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
dataworks:*get
*全部资源
*

请求参数

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

项目 ID。

100
BizDatelong

业务日期。一般是周期实例定时时间的前一天的 0 点 0 分 0 秒,格式为毫秒级时间戳,如 1743350400000。

1710239005403
Typestring

工作流实例的类型。

  • Normal:周期调度
  • Manual:手动任务
  • SmokeTest:测试
  • SupplementData:补数据
  • ManualWorkflow:手动工作流
Normal
WorkflowIdlong

所属工作流的 ID。

1234
Namestring

名称。支持模糊查询。

WorkflowInstance1
Idsarray

工作流实例 ID 列表,可根据工作流实例 Id 批量查询多个工作流实例信息。

Idlong

工作流实例 ID。

1234
Ownerstring

责任人的账号 ID。

1000
SortBystring

排序字段列表,支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"(Asc 可以缺省)。排序字段的枚举值如下:

  • TriggerTime (Desc/Asc)
  • StartedTime (Desc/Asc)
  • FinishedTime (Desc/Asc)
  • CreateTime (Desc/Asc)
  • Id (Desc/Asc)

默认值:Id Desc

Id Desc
PageSizeinteger

每页的条目数,默认为 10。

10
PageNumberinteger

页码,从 1 开始,默认为 1。

1

返回参数

名称类型描述示例值
名称类型描述示例值
object
RequestIdstring

请求的 ID。用于定位日志,排查问题。

22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfoobject

分页信息。

WorkflowInstancesarray<object>

工作流实例列表。

WorkflowInstanceobject
Idlong

工作流实例的唯一标识符。

1234
WorkflowIdlong

所属工作流的 ID。

1234
Namestring

名称。

WorkflowInstance1
Typestring

工作流实例的类型。

  • Normal:周期调度
  • Manual:手动任务
  • SmokeTest:测试
  • SupplementData:补数据
  • ManualWorkflow:手动工作流
Normal
Statusstring

工作流实例运行状态。

  • NotRun:未运行
  • Running:运行中
  • WaitTime:等待 TriggerTime 到来
  • CheckingCondition:分支条件检验
  • WaitResource:等待资源
  • Failure:执行失败
  • Success:执行成功
  • Checking:下发给数据质量校检
Success
BizDatelong

业务日期。

1710239005403
StartedTimelong

开始运行时间。

1710239005403
FinishedTimelong

完成时间。

1710239005403
ProjectIdlong

项目 ID。

100
EnvTypestring

项目环境。

  • Prod(生产)
  • Dev(开发)
Prod
CreateTimelong

创建时间。

1710239005403
ModifyTimelong

修改时间。

1710239005403
CreateUserstring

创建用户的账号 ID。

100
ModifyUserstring

修改用户的账号 ID。

100
TotalCountinteger

数据总条数。

100
PageSizeinteger

每页的条目数。

10
PageNumberinteger

页码。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "WorkflowInstances": [
      {
        "Id": 1234,
        "WorkflowId": 1234,
        "Name": "WorkflowInstance1",
        "Type": "Normal",
        "Status": "Success",
        "BizDate": 1710239005403,
        "StartedTime": 1710239005403,
        "FinishedTime": 1710239005403,
        "ProjectId": 100,
        "EnvType": "Prod",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "100",
        "ModifyUser": "100"
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
文档反馈