文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 查询批量执行流水线结果 - ShowBatchRunResult
更新时间:2025-12-10 GMT+08:00
分享

查询批量执行流水线结果 - ShowBatchRunResult

功能介绍

查询批量执行流水线结果

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/api/pipelines/batch-runs/result

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

query

Array of query objects

参数解释

请求体。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 query

参数

是否必选

参数类型

描述

pipeline_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

pipeline_run_id

String

参数解释

流水线运行实例ID,启动流水线接口的返回值即为流水线运行实例ID。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

Array of result objects

参数解释

响应体。

取值范围

不涉及。

表5 result

参数

参数类型

描述

pipeline_id

String

参数解释

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

取值范围

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

pipeline_name

String

参数解释

流水线名称。

取值范围

不涉及。

pipeline_run_id

String

参数解释

流水线运行实例ID,启动流水线接口的返回值即为流水线运行实例ID。

取值范围

不涉及。

status

String

参数解释

流水线启动状态。

取值范围

不涉及。

reason

String

参数解释

流水线启动失败原因。

取值范围

不涉及。

请求示例

POST https://{endpoint}/v5/db8d07265e24426598b3eb03a7818972/api/pipelines/batch-runs/result

{
  "query" : [ {
    "pipeline_id" : "6ba9a2dbc7024c22a9a6614516dc22db",
    "pipeline_run_id" : "e41fe3981361476eb6dad17ad98c683c"
  } ]
}

响应示例

状态码:200

响应体

{
  "result" : [ {
    "pipeline_id" : "6ba9a2dbc7024c22a9a6614516dc22db",
    "pipeline_name" : "父流水线b",
    "pipeline_run_id" : "e41fe3981361476eb6dad17ad98c683c",
    "status" : "START_FAILED",
    "reason" : "Current pipeline is banned."
  } ]
}

状态码

状态码

描述

200

响应体

错误码

请参见错误码

相关文档