文档首页/ 流水线 CodeArts Pipeline/ API参考(联盟区域)/ API/ 流水线管理/ 批量获取有执行记录的流水线状态
更新时间:2026-01-09 GMT+08:00

批量获取有执行记录的流水线状态

功能介绍

批量获取流水线状态,返回流水线及其最后一次执行的基本信息。若需要查询某条流水线具体一次执行可使用获取流水线状态/获取流水线执行详情接口。

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/api/pipelines/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

32位字符,由数字和字母组成。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

Array of strings

参数解释

流水线ID列表。可以通过查询流水线列表接口,其中pipelines.pipelineId即为流水线ID。

取值范围

32位字符,仅由数字和字母组成。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of PipelineLatestRun objects

参数解释

流水线及其最近一次运行信息。

取值范围

不涉及。

表5 PipelineLatestRun

参数

参数类型

描述

pipeline_id

String

参数解释

流水线ID。

取值范围

32位字符,仅由数字和字母组成。

pipeline_run_id

String

参数解释

流水线运行实例ID。

取值范围

32位字符,仅由数字和字母组成。

executor_id

String

参数解释

执行人ID。

取值范围

32位字符,仅由数字和字母组成。

executor_name

String

参数解释

执行人名称。

取值范围

不涉及。

stage_status_list

Array of stage_status_list objects

参数解释

阶段状态信息列表,包含各阶段的详细状态信息。

约束限制

不涉及。

status

String

参数解释

流水线运行实例状态。

取值范围

  • COMPLETED:已完成。

  • RUNNING:运行中。

  • FAILED:失败。

  • CANCELED:取消。

  • PAUSED:暂停。

  • SUSPEND:挂起。

  • IGNORED:忽略。

run_number

Integer

参数解释

流水线运行序号。

取值范围

大于等于 1。

trigger_type

String

参数解释

触发类型。

取值范围

  • Manual:手动触发。

  • Scheduler:定时任务。

  • MR:MR触发。

  • Push:Push事件触发。

  • CreateTag:Tag事件触发。

  • Issue:Issue触发。

  • Note:评论触发。

build_params

build_params object

参数解释

构建参数。

取值范围

不涉及。

artifact_params

artifact_params object

参数解释

制品源参数。

取值范围

不涉及。

start_time

Long

参数解释

流水线开始时间。

取值范围

不涉及。

end_time

Long

参数解释

流水线结束时间。

取值范围

不涉及。

modify_url

String

参数解释

修改页地址。

取值范围

不涉及。

detail_url

String

参数解释

详情页地址。

取值范围

不涉及。

表6 job_status_list

参数

参数类型

描述

name

String

参数解释

job名字。

取值范围

不涉及。

identifier

String

参数解释

job标识。

取值范围

不涉及

status

String

参数解释

job状态。

取值范围

  • COMPLETED:已完成。

  • RUNNING:运行中。

  • FAILED:失败。

  • CANCELED:取消。

  • PAUSED:暂停。

  • SUSPEND:挂起。

  • IGNORED:忽略。

表7 stage_status_list

参数

参数类型

描述

name

String

参数解释

阶段名称。

取值范围

仅支持输入中文、大小写英文字母、数字、'-'、'_'、','、';'、':'、'.'、'/'、'('、')'、'('、')'及空格,其中空格不可在名称开头或结尾使用,且长度为[1,128]个字符。

sequence

Integer

参数解释

阶段序列号,0代表第一个流水线阶段。

取值范围

大于等于零。

status

String

参数解释

流水线阶段状态。

取值范围

  • INIT:初始化。

  • QUEUED:排队。

  • RUNNING:运行中。

  • CANCELED:取消。

  • COMPLETED:已完成。

  • FAILED:失败。

  • SKIPPED:跳过。

  • IGNORED:忽略。

  • PAUSED:暂停。

  • SUSPEND:挂起。

  • ASYNC_RUNNING:异步运行。

  • ASYNC_FAILED:异步失败。

  • UNSELECTED:未选择。

  • REDISPATCH:重新调度。

start_time

String

参数解释

阶段开始时间。

取值范围

不涉及。

end_time

String

参数解释

阶段结束时间。

取值范围

不涉及。

表8 build_params

参数

参数类型

描述

action

String

参数解释

合并请求事件类型。

取值范围

  • open:打开。

  • reopen:重开。

  • update:更新。

  • merge:合并。

build_type

String

参数解释

基于分支还是标签触发。

取值范围

  • branch:分支触发。

  • tag:标签触发。

commit_id

String

参数解释

代码仓提交ID。

取值范围

40位字符。

event_type

String

参数解释

运行事件类型。

取值范围

  • Manual:手动触发。

  • Scheduler:定时任务。

  • MR:MR触发。

  • Push:Push事件触发。

  • CreateTag:Tag事件触发。

  • Issue:Issue触发。

  • Note:评论触发。

merge_id

String

参数解释

合并请求ID。

取值范围

不涉及。

message

String

参数解释

代码仓提交信息。

取值范围

不涉及。

source_branch

String

参数解释

源分支。

取值范围

不涉及。

tag

String

参数解释

标签。

取值范围

不涉及。

target_branch

String

参数解释

目标分支。

取值范围

不涉及。

codehub_id

String

参数解释

Repo代码仓ID。

取值范围

不涉及。

git_url

String

参数解释

代码仓https地址。

取值范围

不涉及。

source_codehub_id

String

参数解释

源Repo代码仓ID。

取值范围

不涉及。

source_codehub_url

String

参数解释

源Repo代码仓地址。

取值范围

不涉及。

source_codehub_http_url

String

参数解释

源Repo代码仓http地址。

取值范围

不涉及。

表9 artifact_params

参数

参数类型

描述

version

String

参数解释

包版本。

取值范围

不涉及。

branch_filter

String

参数解释

过滤分支。

取值范围

不涉及。

package_name

String

参数解释

包名称。

取值范围

不涉及。

organization

String

参数解释

docker组织。

取值范围

不涉及。

请求示例

批量获取流水线状态。

指定查询的流水线ID为”d19799d619424b2bb2625ec2d93ea087”。

POST https://{endpoint}/v5/54f90b75fc1447b1b65e8d3a9f77923d/api/pipelines/status

[ "d19799d619424b2bb2625ec2d93ea087" ]

响应示例

状态码:200

OK

[ {
  "pipeline_id" : "d19799d619424b2bb2625ec2d93ea087",
  "pipeline_run_id" : "ad6b7f66283a45be9c1f82b06c831e59",
  "executor_id" : "847a5317086c41798469d0868535943a",
  "executor_name" : "beta环境账号",
  "stage_status_list" : [ {
    "name" : "阶段_1",
    "sequence" : 0,
    "status" : "FAILED",
    "start_time" : "2023-03-04 16:48:09",
    "end_time" : "2023-03-04 16:50:11"
  } ],
  "status" : "FAILED",
  "run_number" : 2,
  "trigger_type" : "Manual",
  "build_params" : {
    "action" : null,
    "build_type" : "branch",
    "commit_id" : "fc93c34f906aeb1cc031e3f6f8b2baeac078ae4b",
    "event_type" : "Manual",
    "merge_id" : null,
    "message" : "init",
    "source_branch" : null,
    "tag" : null,
    "target_branch" : "test-lbdsb11",
    "codehub_id" : "2111699716",
    "git_url" : "https://example.com/clsyz00001/111.git"
  },
  "artifact_params" : null,
  "start_time" : 1677919688000,
  "end_time" : 1677919811000
} ]

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码