工作流

获取工作流任务状态

注意事项

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

请求

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

Query

参数名	类型	描述	默认值	是否必须
`commitId`	string	commitId	无	must

正常返回

[{
    "task_id": 1,
    "url":"xxx",
    "status": "created",
    "create_time": 1592569298,
    "start_time": 1592569298,
    "end_time": 1592569298
}]

output

参数名	类型	描述
`task_id`	int64	任务id
`url`	string	具体url
`status`	string	任务状态
`create_time`	int64	任务创建时间
`start_time`	int64	任务开始时间
`end_time`	int64	任务结束时间

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

错误码对应列表

{
    "resultCode":401,"errorMsg":"auth failed!",
    "resultCode":400,"errorMsg":"param is illegal!"
}

工作流任务重试

注意事项

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

请求

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

路径参数说明

参数名	类型	描述	默认值	是否必须
`id`	int	任务id	无	must
`name`	string	工作流名称	无	must

正常返回

{
    "resultCode": 0,
    "errorMsg": "success"
}

output

参数名	类型	描述
`resultCode`	int	返回码
`errorMsg`	string	错误信息

错误码对应列表

{
    "resultCode":0,"errorMsg":"success",
    "resultCode":401,"errorMsg":"auth failed!",
    "resultCode":400,"errorMsg":"param is illegal!",
    "resultCode":403,"errorMsg":"forbidden"
}

取消工作流任务

注意事项

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

请求

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

路径参数说明

参数名	类型	描述	默认值	是否必须
`id`	int	任务id	无	must
`name`	string	工作流名称	无	must

正常返回

{
    "resultCode": 0,
    "errorMsg": "success"
}

output

参数名	类型	描述
`resultCode`	int	返回码
`errorMsg`	string	错误信息

错误码对应列表

{
    "resultCode":0,"errorMsg":"success",
    "resultCode":401,"errorMsg":"auth failed!",
    "resultCode":400,"errorMsg":"param is illegal!",
    "resultCode":403,"errorMsg":"forbidden"
}

创建工作流任务

注意事项

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

请求

POST /api/directory/workflowTask/create

body 参数样例

{
    "workflow_name":"autoproject-workflow-dev",
    "env_name":"dev",
    "targets":[
        {
            "name":"redis3",
            "build":{
                "repos":[
                    {
                        "repo_name":"voting-app",
                        "branch":"master",
                        "pr":0
                    },
                    {
                        "repo_name":"dyliu",
                        "branch":"master",
                        "pr":0
                    },
                    {
                        "repo_name":"hello-gerrit2",
                        "branch":"master",
                        "pr":0
                    }
                ]
            }
        }
    ]
}

body参数说明

参数名	类型	描述	默认值	是否必须
`workflow_name`	string	工作流名称	无	must
`env_name`	string	集成环境名称	无	must
`targets`	[]TargetArgs	构建参数	无	must

TargetArgs 参数说明

参数名	类型	描述	默认值	是否必须
`name`	string	服务名称	无	must
`build`	BuildArgs	构建参数	无	must

BuildArgs 参数说明

参数名	类型	描述	默认值	是否必须
`repos`	[]Repository	关联代码库信息	无	must

Repository 参数说明

参数名	类型	描述	默认值	是否必须
`repo_name`	string	代码库名称	无	must
`branch`	string	分支	无	must
`pr`	int	pr ID	0	使用pr构建时必传

正常返回

{
    "workflow_name":"autoproject-workflow-dev",
    "task_id":967
}

返回数据说明

参数名	类型	描述
`workflow_name`	string	工作流名称
`task_id`	int	任务编号

错误码对应列表

{
    "resultCode":401,"errorMsg":"auth failed!",
    "resultCode":400,"errorMsg":"param is illegal!",
    "resultCode":403,"errorMsg":"forbidden"
}