文档首页/ 编译构建 CodeArts Build/ API参考/ 任务相关API接口/ 执行构建
更新时间：2024-11-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

执行构建

功能介绍

执行构建任务

调用方法

请参见如何调用API。

URI

POST /v1/job/execute

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

job_id

是

String

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

parameter

否

Array of ParameterItem objects

自定义参数

scm

否

Scm object

代码信息
表2 ParameterItem

参数

是否必选

参数类型

描述

name

是

String

参数名称

value

是

String

参数值
表3 Scm

参数

是否必选

参数类型

描述

build_tag

否

String

代码Tag

build_commit_id

否

String

代码提交ID

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

octopus_job_name

String

临时任务名称

actual_build_number

String

实际构建次数

daily_build_number

String

构建每日编号

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

执行任务ID为“f9d6c8466d614a9788e9a0acf6c15f46”，代码仓名称为“codeBranch”，代码仓分支为“master”的构建任务

POST https://{endpoint}/v1/job/execute

{
  "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

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档