获取流水线状态

获取流水线状态,阶段及任务信息

您可以在API Explorer中调试该接口。

GET /v3/pipelines/{pipeline_id}/status

表1 路径参数
参数	是否必选	参数类型	描述
pipeline_id	是	String	要获取状态的流水线ID

表2 Query参数
参数	是否必选	参数类型	描述
build_id	否	String	要获取状态的执行ID

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
X-Language	否	String	语言类型中文:zh-cn 英文:en-us，默认en-us

状态码： 200

表4 响应Body参数
参数	参数类型	描述
pipeline_id	String	流水线ID
pipeline_name	String	流水线名称
executor	String	执行人
build_id	String	流水线执行ID
start_time	String	开始执行时间
end_time	String	结束执行时间
parameters	Array of PipelineParameter objects	流水线参数
states	Array of PipelineStateStatus objects	流水线执行情况
elapsed_time	String	执行耗时
status	String	流水线运行状态.取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成
outcome	String	流水线执行结果。取值及含义：success：成功；error：失败；aborted：终止
detail_url	String	流水线详情页地址

表5 PipelineParameter
参数	参数类型	描述
name	String	参数名称
value	String	参数值

表6 PipelineStateStatus
参数	参数类型	描述
id	String	阶段或任务标识
name	String	阶段或任务名称
type	String	类别(阶段/任务)
start_time	String	执行开始时间
end_time	String	执行结束时间
elapsed_time	String	运行耗时
status	String	运行状态.取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成
outcome	String	运行结果。取值及含义：success：成功；error：失败；aborted：终止
error_code	String	错误码
error_msg	String	错误信息
children	Array of PipelineStateStatus objects	子任务运行信息(对任务来说是空的)
detail_url	String	任务运行记录跳转链接

状态码： 400

表7 响应Body参数
参数	参数类型	描述
error_msg	String	错误信息
error_code	String	错误码

GET https://{endpoint}/v3/pipelines/8025ba36a87a4dd5af496708c2961817/status?build_id=2

无

请参见错误码。

父主题： 流水线管理

相关文档