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

创建构建模板

功能介绍

创建构建模板

调用方法

请参见如何调用API。

URI

POST /v1/template/create

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

template

是

CreateTemplate object

构建步骤模板，需封装为驼峰式命名

name

是

String

模板命名

description

是

String

模板说明

tool_type

否

String

工具类型

parameters

否

Array of CreateBuildJobParameter objects

构建执行参数列表
表2 CreateTemplate

参数

是否必选

参数类型

描述

steps

是

Array of CreateTemplateSteps objects

构建执行的步骤
表3 CreateTemplateSteps

参数

是否必选

参数类型

描述

properties

否

Map<String,Object>

具体的构建步骤

module_id

是

String

构建模块id

name

否

String

构建模块名称

version

否

String

构建版本

enable

否

Boolean

是否开启
表4 CreateBuildJobParameter

参数

是否必选

参数类型

描述

name

否

String

参数定义名，默认为hudson.model.StringParameterDefinition

params

否

Array of CreateBuildJobParameterParam objects

构建执行参数子参数
表5 CreateBuildJobParameterParam

参数

是否必选

参数类型

描述

name

否

String

参数字段名

value

否

String

参数字段值

limits

否

Array of LimitsParam objects

枚举类参数限制
表6 LimitsParam

参数

是否必选

参数类型

描述

disable

否

String

是否生效，默认为"0"，为生效状态

display_name

否

String

参数展示的名字

name

否

String

参数名字

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

status

String

任务运行结果

result

result object

结果
表8 result

参数

参数类型

描述

uuid

String

uuid

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

POST https://{endpoint}/v1/template/create

{
  "name" : "example",
  "description" : "123",
  "tool_type" : "123123",
  "template" : {
    "steps" : [ {
      "module_id" : "devcloud2018.codeci_action_20043.action",
      "name" : "Maven构建",
      "enable" : true,
      "properties" : null
    } ]
  },
  "parameters" : [ {
    "name" : "hudson.model.StringParameterDefinition",
    "params" : [ {
      "name" : "name",
      "value" : "codeBranch"
    }, {
      "name" : "type",
      "value" : "normalparam"
    }, {
      "name" : "defaultValue",
      "value" : "master"
    }, {
      "name" : "description",
      "value" : "description"
    }, {
      "name" : "deletion",
      "value" : "false"
    }, {
      "name" : "defaults",
      "value" : "true"
    }, {
      "name" : "staticVar",
      "value" : "false"
    }, {
      "name" : "sensitiveVar",
      "value" : "false"
    } ]
  } ]
}

响应示例

状态码： 200

OK

{
  "result" : {
    "uuid" : "77176fe3a02c4a49af822360760a607d"
  },
  "error" : null,
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档