文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 查询当前流水线排队中的记录
更新时间:2024-08-22 GMT+08:00
分享

查询当前流水线排队中的记录

功能介绍

查询当前流水线排队中的记录

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/queued-pipeline

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释: CodeArts项目ID。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。

pipeline_id

String

参数解释: 流水线ID。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Long

偏移量

limit

Long

单页条数

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

offset

Integer

偏移量

limit

Integer

单页条数

total

Integer

总数

queuedPipelines

Array of queuedPipelines objects

排队记录列表

表4 queuedPipelines

参数

参数类型

描述

id

Integer

排队记录ID

pipeline_id

String

流水线ID

pipeline_run_id

String

流水线运行实例ID

region

String

局点

enqueue_time

Integer

入队时间

trigger_type

String

触发类型

creator_id

String

触发人ID

creator_name

String

触发人姓名

status

String

排队状态

请求示例

https://(endpoint)/v5/071112d87d3e4ed49130c691936202e9/api/pipelines/c173d99dbbb54626b64cf5694c0a4e8e/queued-pipeline?offset=0&limit=10

响应示例

状态码: 200

响应体

{
  "offset" : 0,
  "limit" : 10,
  "total" : 1,
  "queuedPipelines" : [ {
    "id" : 136,
    "pipeline_id" : "c173d99dbbb54626b64cf5694c0a4e8e",
    "pipeline_run_id" : "b5c22bc545144ea7bf761191821c8b36",
    "region" : null,
    "enqueue_time" : 1718951334000,
    "trigger_type" : "Manual",
    "creator_id" : "123456",
    "creator_name" : "123-5",
    "status" : "QUEUED"
  } ]
}

状态码

状态码

描述

200

响应体

错误码

请参见错误码

相关文档