获取工作流任务列表，支持过滤、排序和分页查询。
调试
您可以在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 一起使用。
| DESC |
| SourceType | string | 否 | 工作流任务来源类型，支持如下值：
| UNKNOWN |
| Status | string | 否 | 需要过滤的工作流任务的状态，目前有如下几种状态：
| 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 |
| PipelineRunId | string | 否 | 工作流任务 ID，如何获取工作流任务 ID，请参见 ListPipelineRuns 。 | flow-14vioac3k1s07k**** |
返回参数
示例
正常返回示例
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****"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-24 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2022-12-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-12-15 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2022-07-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-06-14 | 新增 OpenAPI | 查看变更详情 |