工作流

获取工作流任务状态

注意事项

  • 目前仅支持 GitLab 的 commitId 查询
  • 支持完整的 commitId 或者输入 commitId 前8位查询

请求

  1. GET /api/directory/workflowTask?commitId=<commitId>

Query

参数名类型描述默认值是否必须
commitIdstringcommitIdmust

正常返回

  1. [{
  2. "task_id": 1,
  3. "url":"xxx",
  4. "status": "created",
  5. "create_time": 1592569298,
  6. "start_time": 1592569298,
  7. "end_time": 1592569298
  8. }]

output

参数名类型描述
task_idint64任务id
urlstring具体url
statusstring任务状态
create_timeint64任务创建时间
start_timeint64任务开始时间
end_timeint64任务结束时间

status的类型: created(创建中)/running(运行中)/passed(通过)/failed(失败)/timeout(超时)/cancelled(取消)

错误码对应列表

  1. {
  2. "resultCode":401,"errorMsg":"auth failed!",
  3. "resultCode":400,"errorMsg":"param is illegal!"
  4. }

工作流任务重试

注意事项

  • 需要有工作流任务重试的权限;

请求

  1. POST /api/directory/workflowTask/id/:id/pipelines/:name/restart

路径参数说明

参数名类型描述默认值是否必须
idint任务idmust
namestring工作流名称must

正常返回

  1. {
  2. "resultCode": 0,
  3. "errorMsg": "success"
  4. }

output

参数名类型描述
resultCodeint返回码
errorMsgstring错误信息

错误码对应列表

  1. {
  2. "resultCode":0,"errorMsg":"success",
  3. "resultCode":401,"errorMsg":"auth failed!",
  4. "resultCode":400,"errorMsg":"param is illegal!",
  5. "resultCode":403,"errorMsg":"forbidden"
  6. }

取消工作流任务

注意事项

  • 需要有取消工作流任务的权限;

请求

  1. POST /api/directory/workflowTask/id/:id/pipelines/:name/cancel

路径参数说明

参数名类型描述默认值是否必须
idint任务idmust
namestring工作流名称must

正常返回

  1. {
  2. "resultCode": 0,
  3. "errorMsg": "success"
  4. }

output

参数名类型描述
resultCodeint返回码
errorMsgstring错误信息

错误码对应列表

  1. {
  2. "resultCode":0,"errorMsg":"success",
  3. "resultCode":401,"errorMsg":"auth failed!",
  4. "resultCode":400,"errorMsg":"param is illegal!",
  5. "resultCode":403,"errorMsg":"forbidden"
  6. }

创建工作流任务

注意事项

  • 需要有创建工作流任务的权限;
  • 暂不支持更新环境变量;
  • 暂不支持高级选项,如工作流空间缓存和 Docker 缓存。

请求

  1. POST /api/directory/workflowTask/create

body 参数样例

  1. {
  2. "workflow_name":"autoproject-workflow-dev",
  3. "env_name":"dev",
  4. "targets":[
  5. {
  6. "name":"redis3",
  7. "build":{
  8. "repos":[
  9. {
  10. "repo_name":"voting-app",
  11. "branch":"master",
  12. "pr":0
  13. },
  14. {
  15. "repo_name":"dyliu",
  16. "branch":"master",
  17. "pr":0
  18. },
  19. {
  20. "repo_name":"hello-gerrit2",
  21. "branch":"master",
  22. "pr":0
  23. }
  24. ]
  25. }
  26. }
  27. ]
  28. }

body参数说明

参数名类型描述默认值是否必须
workflow_namestring工作流名称must
env_namestring集成环境名称must
targets[]TargetArgs构建参数must
TargetArgs 参数说明
参数名类型描述默认值是否必须
namestring服务名称must
buildBuildArgs构建参数must
BuildArgs 参数说明
参数名类型描述默认值是否必须
repos[]Repository关联代码库信息must
Repository 参数说明
参数名类型描述默认值是否必须
repo_namestring代码库名称must
branchstring分支must
printpr ID0使用pr构建时必传

正常返回

  1. {
  2. "workflow_name":"autoproject-workflow-dev",
  3. "task_id":967
  4. }

返回数据说明

参数名类型描述
workflow_namestring工作流名称
task_idint任务编号

错误码对应列表

  1. {
  2. "resultCode":401,"errorMsg":"auth failed!",
  3. "resultCode":400,"errorMsg":"param is illegal!",
  4. "resultCode":403,"errorMsg":"forbidden"
  5. }