注意事项

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

请求

Query

正常返回

[
    {
        "task_id": 49,
        "create_time": 1639466317,
        "start_time": 1639466318,
        "end_time": 1639466354,
        "url": "http://my.zadig.com/v1/projects/detail/proxy/pipelines/multi/workflow-demo/49"
    }
]

返回说明

错误码对应列表

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

注意事项

• 需要有执行工作流的权限
• 支持对状态是 failed(失败)/timeout(超时)/cancelled(取消) 的工作流任务进行重试

请求

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

路径参数说明

正常返回

{"message":"success"}

异常返回

注意事项

• 需要有执行工作流的权限；

请求

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

路径参数说明

正常返回

{"message":"success"}

异常返回

{
  "code": 6163,
  "description": "mongo: no documents in result",
  "extra": {},
  "message": "取消工作流任务失败",
  "type": "error"
}

注意事项

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

请求

POST /api/directory/workflowTask/create

body 参数样例

body 参数说明

targets 和 release_images 必须有一个参数存在

TargetArgs 参数说明

BuildArgs 参数说明

Repository 参数说明

Image 参数说明

Callback 参数说明

正常返回

{
  "project_name": "test-project",
  "workflow_name": "test-project-workflow-dev",
  "task_id": 74
}

异常返回

{
  "code": 6540,
  "description": "workflow [hello-world-workflow-dev] 在项目 [hellow-world] 中已经存在!",
  "extra": {},
  "message": "新建或更新wokflow失败",
  "type": "error"
}

请求

GET /api/directory/workflowTask/id/:id/pipelines/:pipelineName

路径参数说明

正常返回

{
    "workflow_name": "test-project-workflow-dev",
    "env_name": "dev",
    "targets": [
        {
            "name": "gss-1",
            "service_type": "helm",
            "build": {
                    {
                        "repo_name": "hzx-test",
                        "branch": "main",
                        "pr": 0
                    }
                ]
            }
        },
        {
            "name": "gss-2",
            "service_type": "helm",
            "build": {
                "repos": [
                    {
                        "repo_name": "hzx-test",
                        "branch": "main",
                        "pr": 0
                ]
            }
        }
    ],
    "images": [
        {                    
                "image": "ccr.ccs.tencentyun.com/trial/go-sample-site:20211221120415-1-main",
                "service_name": "gss-1",
                "registry_repo" : "https://ccr.ccs.tencentyun.com/trial"                    
        },
        {                    
                "image": "ccr.ccs.tencentyun.com/trial/go-sample-site:20211221120415-1-main",
                "service_name": "gss-2",
                "registry_repo" : "https://ccr.ccs.tencentyun.com/trial"                    
        }
    ],
    "test_reports": [
        {
            "test_name": "test",
            "function_test_report": {
                "tests": 24,
                "successes": 24,
                "failures": 0,
                "skips": 0,
                "errors": 0,
                "detail_url": "/v1/projects/detail/test-project/pipelines/multi/testcase/test-project-workflow-dev/51/test/test-project-workflow-dev-51-test?is_workflow=1&service_name=test&test_type=function"
            }
        }
   ],
}

返回说明

Image 参数说明

TestReport 参数说明

FunctionTestReport 参数说明

异常返回