获取流水线列表
功能介绍
获取流水线列表接口
调试
您可以在API Explorer中调试该接口。
URI
POST /v3/pipelines/list
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
X-Language |
否 |
String |
语言类型 中文:zh-cn 英文:en-us,默认en-us |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pipeline_name |
否 |
String |
流水线名字。查询时进行模糊匹配。 |
project_ids |
否 |
String |
项目id,有多个值时用逗号分隔,id个数取值[0,10],非必选。如果该参数有值,则获取对应项目下的流水线列表;如果没有值,则获取用户有权限的所有项目的流水线列表 |
creator_ids |
否 |
String |
创建人id,有多个值时用逗号分隔,id个数取值[0,10],非必选 |
executor_ids |
否 |
String |
执行人id。有多个值时用逗号分隔,id个数取值[0,10],非必选 |
status |
否 |
String |
流水线运行状态.取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成 |
outcome |
否 |
String |
流水线执行结果。取值及含义:success:成功;error:失败;aborted:终止 |
sort_key |
否 |
String |
用于排序的字段。取值为:pipeline_name,create_time,start_time |
sort_dir |
否 |
String |
排序方式。asc按排序字段升序,desc按排序字段降序 |
git_url |
否 |
String |
代码仓地址。仅支持codehub仓库,如:git@codehub.XXX.git |
offset |
否 |
Integer |
偏移量。表示从此偏移量开始查询,offset大于等于0,默认取值为0 |
limit |
否 |
Integer |
每次查询的条目数量。取值[10-50],默认取值为10 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
offset |
Integer |
偏移量,表示从此偏移量开始查询,offset大于等于0 |
limit |
Integer |
每次查询的条目数量 |
total |
Integer |
总条目数量 |
result |
Array of PipelineBasicInfo objects |
流水线列表 |
参数 |
参数类型 |
描述 |
---|---|---|
project_id |
String |
项目id |
project_name |
String |
项目名称 |
pipeline_id |
String |
流水线id |
pipeline_name |
String |
流水线名称 |
creator_id |
String |
流水线创建人id |
creator_name |
String |
流水线创建人名字 |
executor_id |
String |
流水线执行人id |
executor_name |
String |
流水线执行人名字 |
start_time |
String |
启动时间 |
create_time |
String |
创建时间 |
watched |
String |
用户是否关注流水线:true(关注),false(未关注) |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息 |
error_code |
String |
错误码 |
请求示例
POST https://{endpoint}/v3/pipelines/list
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。
