获取流水线的关联的任务列表
功能介绍
获取流水线的关联的任务列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/pipelines/{pipeline_id}/jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
pipeline_id |
是 |
Integer |
参数解释: 流水线 id。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-Total |
Integer |
参数解释: 当前请求的结果总条数。 |
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of JobWithStageDto objects |
任务带阶段信息 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
任务ID 取值范围: 1-2147483647 |
sha |
String |
提交ID |
ref |
String |
分支 |
status |
String |
阶段状态, pending为排队,running为运行中,success为成功,failed为失败,canceled为取消,skipped为跳过,timedout为超时 枚举值:
|
name |
String |
任务名称 |
target_url |
String |
任务链接 |
created_at |
String |
创建时间 |
updated_at |
String |
更新时间 |
started_at |
String |
开始时间 |
finished_at |
String |
结束时间 |
third_build_id |
String |
任务在构建系统中的ID |
stage_id |
Integer |
阶段ID 取值范围: 1-2147483647 |
stage |
String |
阶段名称 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/repositories/2111976239/pipelines/6/jobs
响应示例
状态码:200
OK
[ { "id" : 31930, "sha" : "1c46c505c84853887efe2ea9ea02a1333bae2237", "ref" : "dev", "status" : "success", "name" : "任务1", "target_url" : "https://example.com/cicd/project/72271b5446614062a01b8be944c9f372/pipeline/detail/724cb378007d4303b91f85161f67d6b0/c9cfdc8b918e44c09ad1cdd8c6b13c78\"", "created_at" : "2025-05-17T11:02:25.000+08:00", "started_at" : "2025-05-17T11:02:25.000+08:00", "finished_at" : "2025-05-17T11:02:56.000+08:00", "updated_at\"" : "2025-05-17T11:02:56.000+08:00", "third_build_id" : "0ede266890ddd33cff76da30090b9780", "stage_id" : 123, "stage" : "external" } ]
状态码:401
Unauthorized
{ "error_code" : "CH.00000002", "error_msg" : "认证信息无法识别" }
状态码:404
Not Found
{ "error_code" : "CH.00402000", "error_msg" : "该仓库不存在,请检查后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
404 |
Not Found |
错误码
请参见错误码。