Skip to content

Latest commit

 

History

History
140 lines (106 loc) · 4.8 KB

batch-instantiation-pipeline-template.md

File metadata and controls

140 lines (106 loc) · 4.8 KB
Raw

批量实例化流水线模板

请求方法/请求路径

POST /ms/openapi/api/apigw/v3/projects/{projectId}/templates/{templateId}/templateInstances

资源描述

批量实例化流水线模板

输入参数说明

Query参数

参数名称 参数类型 必须 参数说明 默认值
version integer 是 模板版本
useTemplateSettings boolean 否 是否应用模板设置

Body参数

参数名称 参数类型 必须 参数说明 默认值
body array<TemplateInstanceCreate> 是 创建实例

Path参数

参数名称 参数类型 必须 参数说明 默认值
projectId string 是 项目ID
templateId string 是 模板ID

响应

HTTP代码 说明 参数类型
200 successful operation TemplateOperationRet

请求样例

curl -X POST '[请替换为API地址栏请求地址]?version={version}&amp;useTemplateSettings={useTemplateSettings}' \
-H 'X-DEVOPS-UID:xxx'

HEADER样例

accept: application/json
Content-Type: application/json
X-DEVOPS-UID:xxx

返回样例-200

{
  "data" : {
    "failurePipelines" : "string",
    "failureMessages" : {
      "string" : "string"
    },
    "successPipelinesId" : "string",
    "successPipelines" : "string"
  },
  "message" : "String",
  "status" : 0
}

TemplateInstanceCreate

参数名称 参数类型 必须 参数说明
pipelineName string 否 pipelineName
param List<构建模型-表单元素属性> 否 param
buildNo BuildNo 否 buildNo

构建模型-表单元素属性

参数名称 参数类型 必须 参数说明
defaultValue object 是 默认值
containerType BuildContainerType 否 构建机类型下拉
glob string 否 自定义仓库通配符
replaceKey string 否 替换搜索url中的搜素关键字
readOnly boolean 否 是否只读
label string 否 元素标签
type ENUM(STRING, TEXTAREA, ENUM, DATE, LONG, BOOLEAN, SVN_TAG, GIT_REF, MULTIPLE, CODE_LIB, CONTAINER_TYPE, ARTIFACTORY, SUB_PIPELINE, CUSTOM_FILE, PASSWORD, TEMPORARY, ) 是 元素类型
required boolean 是 是否必须
repoHashId string 否 repoHashId
scmType ENUM(CODE_SVN, CODE_GIT, CODE_GITLAB, GITHUB, CODE_TGIT, ) 否 代码库类型下拉
relativePath string 否 relativePath
propertyType string 否 元素模块
options List<构建模型-下拉框表单元素值> 否 下拉框列表
searchUrl string 否 搜索url, 当是下拉框选项时，列表值从url获取不再从option获取
id string 是 元素ID-标识符
placeholder string 否 元素placeholder
properties object 否 文件元数据
desc string 否 描述

BuildContainerType

参数名称 参数类型 必须 参数说明
os ENUM(MACOS, WINDOWS, LINUX, ) 否 os
buildType ENUM(ESXi, MACOS, DOCKER, IDC, PUBLIC_DEVCLOUD, TSTACK, THIRD_PARTY_AGENT_ID, THIRD_PARTY_AGENT_ENV, THIRD_PARTY_PCG, THIRD_PARTY_DEVCLOUD, GIT_CI, AGENT_LESS, ) 否 buildType

构建模型-下拉框表单元素值

参数名称 参数类型 必须 参数说明
value string 是 元素值名称-显示用
key string 是 元素值ID-标识符

BuildNo

参数名称 参数类型 必须 参数说明
buildNoType ENUM(CONSISTENT, SUCCESS_BUILD_INCREMENT, EVERY_BUILD_INCREMENT, ) 否 buildNoType
buildNo integer 否 buildNo
required boolean 否 required

TemplateOperationRet

参数名称 参数类型 必须 参数说明
data TemplateOperationMessage 否 data
message string 否 message
status integer 否 status

TemplateOperationMessage

参数名称 参数类型 必须 参数说明
failurePipelines List 否 failurePipelines
failureMessages object 否 failureMessages
successPipelinesId List 否 successPipelinesId
successPipelines List 否 successPipelines