批量获取流水线状态
功能介绍
批量获取流水线状态和阶段信息
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/pipelines/status
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pipeline_ids |
是 |
String |
要获取状态的流水线ID,用逗号隔开 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
X-Language |
否 |
String |
语言类型 中文:zh-cn 英文:en-us,默认en-us |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of PipelineExecuteStates objects |
OK |
参数 |
参数类型 |
描述 |
---|---|---|
result |
String |
流水线执行结果。取值及含义:success:成功;error:失败;aborted:终止 |
status |
String |
流水线执行状态.取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成 |
stages |
Array of Stages objects |
阶段执行情况 |
executor |
String |
执行人 |
pipeline_name |
String |
流水线名字 |
pipeline_id |
String |
流水线ID |
build_id |
String |
流水线执行ID |
detail_url |
String |
流水线详情页URL |
modify_url |
String |
流水线编辑页URL |
start_time |
String |
开始执行时间 |
end_time |
String |
结束执行时间 |
参数 |
参数类型 |
描述 |
---|---|---|
result |
String |
阶段执行结果。取值及含义:success:成功;error:失败;aborted:终止 |
status |
String |
阶段执行状态。取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成 |
name |
String |
阶段名字 |
parameters |
Object |
- |
order |
Integer |
阶段顺序 |
dsl_method |
String |
阶段类型 |
display_name |
String |
阶段显示名称 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息 |
error_code |
String |
错误码 |
请求示例
GET https://{endpoint}/v3/pipelines/status?pipeline_ids=8025ba36a87a4dd5af496708c2961817,413937e669914f95bed293617886c6c1
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。
