调用ListPipelineRuns获取工作流任务列表_人工智能平台 PAI(PAI)-阿里云帮助中心

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

调试

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

调试

授权信息

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

请求语法

GET /api/v1/pipelineruns

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	工作流任务列表的页码。起始值为1，默认为1。	1
PageSize	integer	否	分页查询时设置的每页显示的工作流任务数量，默认为10。	10
SourceId	string	否	工作流任务来源ID。请在工作流详情页面查看工作流任务来源ID，详情请参见管理工作流。	ybpy**********fb2z
Name	string	否	工作流任务名称。	testName
Order	string	否	排序的顺序，取值如下，与SortBy一起使用。 ASC：升序。 DESC（默认值）：降序。	DESC
SourceType	string	否	工作流任务来源类型，支持如下值： UNKNOWN（默认）：未指定来源类型时的默认值。 SDK：通过SDK创建的工作流任务。 DESIGNER：通过Designer创建的工作流任务。 M6：通过其他网站创建的工作流任务。	UNKNOWN
Status	string	否	需要过滤的工作流任务的状态，目前有如下几种状态： Initialized Running Succeeded Failed Terminated Unknown Skipped Terminating	Succeeded
WorkspaceId	string	否	工作空间ID。如何获取工作空间ID，请参见 ListWorkspaces。	104623
UserId	string	否	用户ID。	155**********904
PipelineIds	string	否	工作流的ID集合，多个工作流ID使用半角逗号（,）分隔。如何获取工作流ID，请参见ListPipelines。	flow-rer7********0otv, flow-hynm********sfef
SortBy	string	否	用于排序的字段。目前有如下字段支持用于排序： PipelineId UserId ParentUserId StartedAt FinishedAt WorkflowServiceId Duration GmtCreateTime GmtModifiedTime	PipelineId
PipelineRunId	string	否	工作流任务ID，如何获取工作流任务ID，请参见ListPipelineRuns。	flow-14vioac3k1s07k****

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求ID。	473469C7-**--**-A3DC0DE3C83E
TotalCount	long	返回的工作流任务总量。	15
PipelineRuns	object []	返回的工作流任务列表。
PipelineRunId	string	工作流任务ID。	flow-j94y**********lf7a
Name	string	工作流任务名字。	testName
Status	string	工作流任务状态，目前有下面几种状态： Initialized Running Succeeded Failed Suspended Terminated Unknown Skipped Terminating	Succeeded
UserId	string	创建用户ID。	155**********904
ParentUserId	string	创建用户主账户的ID。	155**********904
StartedAt	string	工作流任务的开始UTC时间，格式iso8601。	2021-01-30T12:51:33.028Z
FinishedAt	string	工作流任务的结束UTC时间，格式iso8601。	2021-01-30T12:52:33.028Z
NodeId	string	工作流任务的节点ID。	node-n06d**********fc53
Duration	integer	工作流任务的运行时长，单位为秒。	60
WorkspaceId	string	所属工作空间ID。	15945
Message	string	工作流任务失败提示信息。	error message
SourceType	string	工作流任务来源类型，支持如下值： UNKNOWN SDK DESIGNER M6	UNKNOWN
SourceId	string	工作流任务的来源ID。	abcd*********hxfu
GmtCreateTime	string	创建UTC时间，格式iso8601。	2021-01-30T12:51:33.028Z
GmtModifiedTime	string	最近修改UTC时间，格式iso8601。	2021-01-30T12:51:33.028Z
PipelineId	string	工作流ID。	pipeline-j94y**********lf7a
Accessibility	string	工作流任务的可见性，目前支持： PUBLIC PRIVATE	PUBLIC
PipelineRunUri	string	工作流任务详情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-15

OpenAPI 返回结构发生变更

变更项	变更内容
出参	OpenAPI 返回结构发生变更

2022-12-15

OpenAPI 入参发生变更

变更项	变更内容
入参	OpenAPI 入参发生变更
	新增入参：PipelineRunId

2022-07-06

OpenAPI 返回结构发生变更

变更项	变更内容
出参	OpenAPI 返回结构发生变更

2022-06-14

新增 OpenAPI