获取项目下流水线执行状况
功能介绍
获取项目下流水线执行状况
调用方法
请参见如何调用API。
URI
GET /v3/pipelines/build-result
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
start_date |
是 |
String |
参数解释: 起始日期。 约束限制: 起始日期和结束日期间隔不超过一个月,查询包含起始日期。 取值范围: 不涉及。 默认取值: 不涉及。 |
end_date |
是 |
String |
参数解释: 起始日期。 约束限制: 起始日期和结束日期间隔不超过一个月,查询包含起始日期。 取值范围: 不涉及。 默认取值: 不涉及。 |
offset |
是 |
Integer |
参数解释: 偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 不涉及。 |
limit |
是 |
Integer |
参数解释: 每次查询的条目数量。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
offset |
Integer |
参数解释: 偏移量,表示从此偏移量开始查询。 取值范围: offset大于等于0。 |
limit |
Integer |
参数解释: 每次查询的条目数量。 取值范围: 大于等于0。 |
total |
Integer |
参数解释: 总条目数量。 取值范围: 不涉及。 |
build_results |
Array of PipelineBuildResult objects |
参数解释: 执行状况数据列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
build_id |
String |
参数解释: 流水线执行ID。 取值范围: 不涉及。 |
elapse_time |
String |
参数解释: 运行耗时,单位为毫秒。 取值范围: 不涉及。 |
end_time |
String |
参数解释: 执行结束时间。 取值范围: 不涉及。 |
outcome |
String |
参数解释: 运行结果。 取值范围:
|
pipeline_id |
String |
参数解释: 流水线id。 取值范围: 32位字符,由数字和字母组成。 |
pipeline_name |
String |
参数解释: 流水线名称。 取值范围: 不涉及。 |
start_time |
String |
参数解释: 执行开始时间。 取值范围: 不涉及。 |
status |
String |
参数解释: 运行状态。 取值范围:
|
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v3/pipelines/build-result?project_id=8025ba36a87a4885af496708c2961817&start_date=2020-07-01&end_date=2020-07-31&offset=0&limit=10
响应示例
状态码:200
OK
{ "offset" : 0, "limit" : 10, "total" : 29, "build_results" : [ { "status" : "completed", "outcome" : "success", "pipeline_id" : "fbe06e5655764f049f4d988bd2941279", "pipeline_name" : "接口测试流水线_YN96I241", "build_id" : "12", "start_time" : "2021-08-10 00:00:01", "end_time" : "2021-08-10 00:00:02", "elapse_time" : "917" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。