获取合并请求关联的最新流水线
功能介绍
获取合并请求关联的最新流水线
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/actual-head-pipeline
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
merge_request_iid |
是 |
Integer |
参数解释: 合并请求 iid。 取值范围: 1-2147483647 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
PipelineDetailDto object |
流水线详情 |
is_valid |
Boolean |
最新的commit是否有对应的流水线 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
流水线ID 取值范围: 1-2147483647 |
web_url |
String |
流水线链接 |
sha |
String |
commit id |
ref |
String |
分支 |
status |
String |
流水线状态,pending为排队,running为运行中,success为成功,failed为失败,canceled为取消,skipped为跳过,timedout为超时 枚举值:
|
created_at |
String |
流水线创建时间 |
updated_at |
String |
流水线更新时间 |
started_at |
String |
流水线开始时间 |
finished_at |
String |
流水线结束时间 |
repository_id |
Integer |
仓库ID 取值范围: 1-2147483647 |
is_invalid |
Boolean |
流水线是否失效 |
type |
String |
流水线类型,MERGE REQUEST代表为合并请求触发的流水线 枚举值:
|
stages |
Array of PipelineStageDto objects |
阶段信息 |
is_latest |
Boolean |
是否是最近一条流水线 |
trigger_user |
String |
触发的用户 |
all_job_finished |
Boolean |
是否所有job都运行完成 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
阶段ID 取值范围: 1-2147483647 |
repository_id |
Integer |
仓库ID 取值范围: 1-2147483647 |
pipeline_id |
Integer |
流水线ID 取值范围: 1-2147483647 |
name |
String |
阶段名称 |
sort_id |
Integer |
阶段顺序id 取值范围: 1-2147483647 |
status |
String |
阶段状态, pending为排队,running为运行中,success为成功,failed为失败,canceled为取消,skipped为跳过,timedout为超时 枚举值:
|
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
/v4/repositories/2111976239/merge-requests/6/actual-head-pipeline
响应示例
状态码:200
OK
{ "is_valid" : true, "data" : { "id" : 8125, "web_url" : "https://example.com/72271b5446614062a01b8be944c9f372/hxb11222/pipelines/8125", "sha" : "5167228a3d13f9d59f969104c6fc4dbb38f7b5cc", "ref" : "master", "status" : "failed", "created_at" : "2024-12-12T20:47:46.000+08:00", "updated_at" : "2024-12-12T20:47:47.000+08:00", "started_at" : "2024-12-12T20:47:47.000+08:00", "finished_at" : "2024-12-12T20:47:47.000+08:00", "repository_id" : 2111976239, "is_invalid" : null, "type" : "MERGE REQUEST", "stages" : [ { "id" : 12625, "repository_id" : 2111976239, "pipeline_id" : 8125, "name" : "CodeArtsCheck", "sort_id" : null, "status" : "failed" } ], "is_latest" : true, "trigger_user" : null, "all_job_finished" : true } }
状态码:401
Unauthorized
{ "error_code" : "CH.00000002", "error_msg" : "认证信息无法识别" }
状态码:404
Not Found
{ "error_code" : "CH.00402000", "error_msg" : "该仓库不存在,请检查后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
404 |
Not Found |
错误码
请参见错误码。