更新时间:2022-04-15 GMT+08:00
分享

执行构建任务

功能介绍

执行构建任务,可传自定义参数。

调试

您可以在API Explorer中调试该接口。

URI

POST /v3/jobs/build

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务 获取IAM用户Token接口获取 (响应消息头中X-Subject-Token的值)。 不支持租户全局token,请使用scope为project的region级token。

表2 请求Body参数

参数

是否必选

参数类型

描述

job_id

String

构建任务ID;编辑构建任务时,浏览器URL末尾的32位数字、字母组合的字符串

parameter

Array of ParameterItem objects

自定义参数

scm

Scm object

代码信息

表3 ParameterItem

参数

是否必选

参数类型

描述

name

String

参数名称

value

String

参数值

表4 Scm

参数

是否必选

参数类型

描述

build_tag

String

代码Tag

build_commit_id

String

代码提交ID

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

octopus_job_name

String

临时任务名称

actual_build_number

String

实际构建次数

daily_build_number

String

构建每日编号

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

POST https://{endpoint}/v3/jobs/build

{
  "job_id" : "f9d6c8466d614a9788e9a0acf6c15f46",
  "parameter" : [ {
    "name" : "codeBranch",
    "value" : "master"
  } ],
  "scm" : {
    "build_tag" : null,
    "build_commit_id" : "build_commit_id"
  }
}

响应示例

状态码: 200

OK

{
  "octopus_job_name" : "j_Oaqg...",
  "actual_build_number" : "20",
  "daily_build_number" : "20200612.20"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close