ListPipelineRuns分页
获取工作流任务列表,支持过滤、排序和分页查询
服务地址:
华东1(杭州)
输入参数
只看必填
SourceId工作流任务来源ID
Name工作流任务名称
Order排序的顺序
SourceType工作流任务来源类型
Status需要过滤的工作流任务的状态
WorkspaceId工作空间ID
UserId用户ID
PipelineIds工作流的ID集合
SortBy用于排序的字段
PipelineRunId工作流任务ID
分页参数
PageNumber工作流任务列表的页码
PageSize分页查询时设置的每页显示的工作流任务数量
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

请求语法

GET /api/v1/pipelineruns HTTP/1.1

请求参数

字段名称字段详情
PageNumberinteger<int32>

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

示例值:1
PageSizeinteger<int32>

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

示例值:10
SourceIdstring

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

示例值:ybpy**********fb2z
Namestring

工作流任务名称。

示例值:testName
Orderstring

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

示例值:DESC
SourceTypestring

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

示例值:UNKNOWN
Statusstring

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

示例值:Succeeded
WorkspaceIdstring

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

示例值:104623
UserIdstring

用户 ID。

示例值:155**********904
PipelineIdsstring

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

示例值:flow-rer7**********0otv, flow-hynm**********sfef参考取值来源:
    ListPipelines
    GetPipeline
    CreatePipeline
SortBystring

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

示例值:PipelineId
PipelineRunIdstring

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

示例值: flow-14vioac3k1s07k****参考取值来源:
    CreatePipelineRun
    ListPipelineRunsStatus

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:473469C7-****-****-****-A3DC0DE3C83E
TotalCountinteger<int64>

返回的工作流任务总量。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:15
PipelineRunsarray<object>

返回的工作流任务列表。

变更历史
变更时间变更内容概要操作
2022-12-15
变更返回参数
2022-12-15
新增请求参数PipelineRunId
2022-07-06
变更返回参数
2022-06-14
新增OpenAPI,获取工作流任务列表