文档

ListPipelineRuns - 获取工作流任务列表

更新时间:

获取工作流任务列表,支持过滤、排序和分页查询。

调试

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

调试

授权信息

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

请求语法

GET /api/v1/pipelineruns

请求参数

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

工作流任务列表的页码。起始值为1,默认为1。

1
PageSizeinteger

分页查询时设置的每页显示的工作流任务数量,默认为10。

10
SourceIdstring

工作流任务来源ID。请在工作流详情页面查看工作流任务来源ID,详情请参见管理工作流

ybpy**********fb2z
Namestring

工作流任务名称。

testName
Orderstring

排序的顺序,取值如下,与SortBy一起使用。

  • ASC:升序。
  • DESC(默认值):降序。
DESC
SourceTypestring

工作流任务来源类型,支持如下值:

  • UNKNOWN(默认):未指定来源类型时的默认值。
  • SDK:通过SDK创建的工作流任务。
  • DESIGNER:通过Designer创建的工作流任务。
  • M6:通过其他网站创建的工作流任务。
UNKNOWN
Statusstring

需要过滤的工作流任务的状态,目前有如下几种状态:

  • Initialized
  • Running
  • Succeeded
  • Failed
  • Terminated
  • Unknown
  • Skipped
  • Terminating
Succeeded
WorkspaceIdstring

工作空间ID。如何获取工作空间ID,请参见 ListWorkspaces

104623
UserIdstring

用户ID。

155**********904
PipelineIdsstring

工作流的ID集合,多个工作流ID使用半角逗号(,)分隔。如何获取工作流ID,请参见ListPipelines

flow-rer7**********0otv, flow-hynm**********sfef
SortBystring

用于排序的字段。目前有如下字段支持用于排序:

  • PipelineId
  • UserId
  • ParentUserId
  • StartedAt
  • FinishedAt
  • WorkflowServiceId
  • Duration
  • GmtCreateTime
  • GmtModifiedTime
PipelineId
PipelineRunIdstring

工作流任务ID,如何获取工作流任务ID,请参见ListPipelineRuns

flow-14vioac3k1s07k****

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求ID。

473469C7-****-****-****-A3DC0DE3C83E
TotalCountlong

返回的工作流任务总量。

15
PipelineRunsobject []

返回的工作流任务列表。

PipelineRunIdstring

工作流任务ID。

flow-j94y**********lf7a
Namestring

工作流任务名字。

testName
Statusstring

工作流任务状态,目前有下面几种状态:

  • Initialized
  • Running
  • Succeeded
  • Failed
  • Suspended
  • Terminated
  • Unknown
  • Skipped
  • Terminating
Succeeded
UserIdstring

创建用户ID。

155**********904
ParentUserIdstring

创建用户主账户的ID。

155**********904
StartedAtstring

工作流任务的开始UTC时间,格式iso8601。

2021-01-30T12:51:33.028Z
FinishedAtstring

工作流任务的结束UTC时间,格式iso8601。

2021-01-30T12:52:33.028Z
NodeIdstring

工作流任务的节点ID。

node-n06d**********fc53
Durationinteger

工作流任务的运行时长,单位为秒。

60
WorkspaceIdstring

所属工作空间ID。

15945
Messagestring

工作流任务失败提示信息。

error message
SourceTypestring

工作流任务来源类型,支持如下值:

  • UNKNOWN
  • SDK
  • DESIGNER
  • M6
UNKNOWN
SourceIdstring

工作流任务的来源ID。

abcd*********hxfu
GmtCreateTimestring

创建UTC时间,格式iso8601。

2021-01-30T12:51:33.028Z
GmtModifiedTimestring

最近修改UTC时间,格式iso8601。

2021-01-30T12:51:33.028Z
PipelineIdstring

工作流ID。

pipeline-j94y**********lf7a
Accessibilitystring

工作流任务的可见性,目前支持:

  • PUBLIC
  • PRIVATE
PUBLIC
PipelineRunUristring

工作流任务详情URL。

https://pai.console.aliyun.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-****-****-****-A3DC0DE3C83E",
  "TotalCount": 15,
  "PipelineRuns": [
    {
      "PipelineRunId": "flow-j94y**********lf7a\n",
      "Name": "testName\n",
      "Status": "Succeeded",
      "UserId": "155**********904",
      "ParentUserId": "155**********904",
      "StartedAt": "2021-01-30T12:51:33.028Z\n",
      "FinishedAt": "2021-01-30T12:52:33.028Z\n",
      "NodeId": "node-n06d**********fc53\n",
      "Duration": 60,
      "WorkspaceId": "15945",
      "Message": "error message\n",
      "SourceType": "UNKNOWN",
      "SourceId": "abcd*********hxfu\n",
      "GmtCreateTime": "2021-01-30T12:51:33.028Z\n",
      "GmtModifiedTime": "2021-01-30T12:51:33.028Z\n",
      "PipelineId": "pipeline-j94y**********lf7a\n",
      "Accessibility": "PUBLIC",
      "PipelineRunUri": "https://pai.console.aliyun.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-12-15OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-12-15OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:PipelineRunId
2022-07-06OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-06-14新增 OpenAPI