文档首页/ 流水线 CodeArts Pipeline/ API参考（联盟区域）/ API/ 流水线管理（旧版，待下线）/ 批量获取流水线状态
更新时间：2026-01-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量获取流水线状态

功能介绍

批量获取流水线状态和阶段信息

调用方法

请参见如何调用API。

URI

GET /v3/pipelines/status

表1 Query参数

参数

是否必选

参数类型

描述

pipeline_ids

是

String

要获取状态的流水线ID，用逗号隔开

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。通过调用获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

[数组元素]

Array of PipelineExecuteStates objects

流水线执行结果
表4 PipelineExecuteStates

参数

参数类型

描述

result

String

流水线执行结果。取值及含义：success：成功；error：失败；aborted：终止

status

String

参数解释：

流水线执行状态。

约束限制：

不涉及。

取值范围：

  • waiting：等待中。

  • running：运行中。

  • verifying：待审核。

  • suspending：挂起。

  • completed：执行完成。

默认取值：

不涉及。

stages

Array of Stages objects

阶段执行情况

executor

String

执行人

pipeline_name

String

流水线名字

pipeline_id

String

流水线ID

build_id

String

流水线执行ID

detail_url

String

流水线详情页URL

modify_url

String

流水线编辑页URL

start_time

String

开始执行时间

end_time

String

结束执行时间
表5 Stages

参数

参数类型

描述

result

String

阶段执行结果。取值及含义：success：成功；error：失败；aborted：终止

status

String

阶段执行状态。取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成

name

String

阶段名字

parameters

Object

阶段运行参数

order

Integer

阶段顺序

dsl_method

String

阶段类型

display_name

String

阶段显示名称

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

请求示例

GET https://{endpoint}/v3/pipelines/status?pipeline_ids=8025ba36a87a4dd5af496708c2961817,413937e669914f95bed293617886c6c1

响应示例

状态码：200

OK

[ {
  "result" : "error",
  "status" : "completed",
  "stages" : [ {
    "result" : "success",
    "status" : "completed",
    "name" : "initial",
    "parameters" : null,
    "order" : 1,
    "dsl_method" : "initial",
    "display_name" : "源代码"
  }, {
    "result" : "success",
    "status" : "completed",
    "name" : "state_3",
    "parameters" : null,
    "order" : 2,
    "dsl_method" : "build",
    "display_name" : "构建"
  } ],
  "executor" : "executor",
  "pipeline_name" : "PipelineSvc测试勿删_继续执行",
  "pipeline_id" : "92a65e2337174fabbdbccda97ab7ffad",
  "detail_url" : "https://example.com",
  "modify_url" : "https://example.com",
  "start_time" : "2022-09-09 00:00:00",
  "end_time" : "2022-09-09 00:00:24",
  "build_id" : "25"
} ]

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。