接口功能介绍
调用listPipelinesPage接口查询流水线分页列表
接口约束
无
URI
GET /v1/pipelines/listPipelinesPage
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
appGroupId | 否 | String | 应用分组ID,数据来源于获取应用分组列表 | ||
name | 否 | String | 应用名称/流水线名称 | ||
pageNum | 否 | Integer | 分页查询时当前显示第几页,默认值为1 | 0 | |
pageSize | 否 | Integer | 分页查询时每页显示几条,默认值为10 | 0 | |
projectId | 是 | String | 项目ID,数据来源于分页查询项目列表 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应编码 | 2000 | |
message | String | 消息内容 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 调用错误时返回的错误编码 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
list | Array of Strings | 当前页记录列表 | list | |
pageNum | Integer | 当前页 | 0 | |
pageSize | Integer | 每页行数 | 0 | |
size | Integer | 从startRow到endRow的记录数 | 0 | |
total | Integer | 总行数 | 0 | |
startRow | Long | 当前页第一个元素在所有记录的序号 | ||
endRow | Long | 当前页最后一个元素在所有记录的序号 | ||
pages | Integer | 总页数 | 0 | |
prePage | Integer | 前一页 | 0 | |
nextPage | Integer | 下一页 | 0 | |
isFirstPage | Boolean | 是否为第一页 | ||
isLastPage | Boolean | 是否为最后一页 | ||
hasPreviousPage | Boolean | 是否有前一页 | ||
hasNextPage | Boolean | 是否有下一页 | ||
navigatePages | Integer | 导航页码数 | 0 | |
navigatepageNums | Array of Strings | 所有导航页页号,Integer数组 | ||
navigateFirstPage | Integer | 导航条上的第一页 | 0 | |
navigateLastPage | Integer | 导航条上的最后一页 | 0 |
表 list
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
appCode | String | 应用编码 | ||
appId | String | 应用ID | ||
appName | String | 应用名称 | ||
createStaff | String | 创建人 | ||
createTime | String | 创建时间 | ||
deleted | Boolean | 是否删除 false true | ||
description | String | 流水线描述 | ||
enablePause | Boolean | 是否能暂停 | ||
enableResume | Boolean | 是否能重新执行 | ||
enableRun | Boolean | 是否能执行 | ||
pipelineOrderId | String | 流水线ID | ||
pipelineOrderName | String | 流水线名称 | ||
projectId | String | 项目ID | ||
stageList | Array of Strings | 执行流程 | ||
stagecategory | String | 流程类型 CODE_BUILD,IMAGE_BUILD,IMAGE_DEPLOY,PACKAGE_PUBLISH,MS_IMAGE_DEPLOY | ||
stagename | String | 流程名称 | ||
stagepipelineOrderId | String | 流水线ID | ||
stagepipelineStageOrderId | String | 流程ID | ||
stagesort | Integer | 流程顺序 | 0 | |
tenantId | Integer | 租户ID | 0 | |
updateStaff | String | 更新时间 | ||
updateTime | String | 更新时间 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode": 2000,
"message": "SUCCESS",
"returnObj": {
"total": 1,
"list": [
{
"pipelineOrderId": "6528a4e7-42bd-46c5-ba77-49dbbe24f09a",
"projectId": "3e8694b6-cc4d-4a7a-962e-5f61a07760e5",
"appId": "a502f51e-10b2-4000-91de-56ef2cd92cb4",
"pipelineOrderName": "流水线 2023-09-11",
"description": null,
"deleted": false,
"tenantId": 840,
"createTime": "2023-09-11T01: 47: 05.000+00: 00",
"createStaff": "ctyun1b7073bb172242541688471755",
"updateTime": "2023-09-11T01: 47: 05.000+00: 00",
"updateStaff": "ctyun1b7073bb172242541688471755",
"stageList": [
{
"pipelineStageOrderId": "ec7502d8-e2d1-4bb7-8b17-563992c65e2c",
"pipelineOrderId": "6528a4e7-42bd-46c5-ba77-49dbbe24f09a",
"name": "编译",
"category": "CODE_BUILD",
"sort": 1
},
{
"pipelineStageOrderId": "49b22f03-eeed-43a8-814d-33aa4e88c2b1",
"pipelineOrderId": "6528a4e7-42bd-46c5-ba77-49dbbe24f09a",
"name": "镜像构建",
"category": "IMAGE_BUILD",
"sort": 2
},
{
"pipelineStageOrderId": "a1ce189d-4b18-48ab-aac2-851175dbe6fe",
"pipelineOrderId": "6528a4e7-42bd-46c5-ba77-49dbbe24f09a",
"name": "镜像部署",
"category": "IMAGE_DEPLOY",
"sort": 3
}
],
"appCode": "test-general-app",
"appName": "test-general-app",
"enablePause": false,
"enableResume": false,
"enableRun": true,
"source": "CODE",
"sourceParam": {
"branchName": "master"
}
}
],
"pageNum": 1,
"pageSize": 1,
"size": 1,
"startRow": 0,
"endRow": 0,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
}
}
状态码
请参考 状态码
错误码
请参考 错误码