빌드 생성(Create Build) (V2)
대상 범위와 실행 설정으로 새 빌드를 요청합니다. target은 필수이며 브랜치, JobSpec 조회용 대체 브랜치와 재시도 및 실패 처리 설정을 선택할 수 있습니다. forceBuild는 데이터의 최신 여부 판단을 무시할지 제어합니다.
이 요청은 실제 계산을 시작할 수 있습니다. 예제는 종료 알림을 사용하지 않도록 notificationsEnabled: false를 명시합니다. 스케줄에 연결된 알림의 수신자와 ProjectScope 예외는 해당 필드의 조건을 따릅니다.
HTTP 요청
POST /api/v2/orchestration/builds/create
작업 식별자는 v2.createBuild입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:orchestration-write 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
지정할 경로 매개변수가 없습니다.
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
본문 형식은 CreateBuildRequest이며 필수입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
target | union<upstream, manual, connecting> | 필수 | 빌드 대상의 범위를 지정합니다. | 본문 예시 참조 |
branchName | string | 선택 | 빌드를 실행할 대상 브랜치입니다. | master |
fallbackBranches | list<BranchName> | 선택 | 대상 브랜치에서 JobSpec을 찾지 못했을 때 실행 작업 명세를 조회할 다른 브랜치 목록입니다. | 본문 예시 참조 |
forceBuild | boolean | 선택 | 빌드를 실행할 때 데이터의 최신 여부 판단을 무시할지 지정합니다. | |
retryCount | integer | 선택 | 실패한 실행 작업의 재시도 횟수입니다. | 1 |
retryBackoffDuration | object | 선택 | 실행 작업 실패 후 다음 재시도까지 기다릴 기간입니다. | 본문 예시 참조 |
abortOnFailure | boolean | 선택 | 활성화하면 실행 작업 하나가 성공하지 못한 결과로 끝날 때 나머지 작업을 취소하여 빌드를 즉시 종료합니다. | false |
notificationsEnabled | boolean | 선택 | 빌드 종료 알림의 사용 여부입니다. 스케줄에 연결된 알림은 스케줄을 가장 최근에 수정한 사용자에게 보내며 scopeMode가 ProjectScope이면 보내지 않습니다. |
target의 구조
세 가지 대상 분기의 전체 조건은 빌드 대상 범위를 따릅니다.
fallbackBranches의 구조
배열 항목은 BranchName이며 자료형은 string입니다.
브랜치 이름입니다.
retryBackoffDuration의 구조
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
value | integer | 필수 | 기간의 수치입니다. | 30 |
unit | enum | 필수 | 기간의 단위입니다. 허용값: MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS. | SECONDS |
다음은 빌드 대상과 실행 설정을 지정하는 요청 본문 예시입니다.
{
"abortOnFailure": false,
"retryBackoffDuration": {
"unit": "SECONDS",
"value": 30
},
"retryCount": 1,
"fallbackBranches": [],
"branchName": "master",
"target": {
"type": "manual",
"targetRids": [
"ri.foundry.main.dataset.4263bdd9-d6bc-4244-9cca-893c1a2aef62",
"ri.foundry.main.dataset.86939c1e-4256-41db-9fe7-e7ee9e0f752a"
]
},
"notificationsEnabled": false
}
응답
응답 형식은 Build입니다.
전체 필드는 Build 응답 모델을 따릅니다.
수동으로 생성하여 실행 중인 빌드의 응답 예시입니다.
{
"abortOnFailure": false,
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"retryBackoffDuration": {
"unit": "SECONDS",
"value": 30
},
"retryCount": 1,
"fallbackBranches": [],
"branchName": "master",
"createdTime": "2003-05-06T12:34:56.789Z",
"jobRids": [
"ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"
],
"rid": "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58",
"status": "RUNNING"
}
개별 오류
| 오류 이름 | 오류 코드 | HTTP | 의미와 조건 | 추가 매개변수 |
|---|---|---|---|---|
CreateBuildPermissionDenied | PERMISSION_DENIED | 403 | 빌드를 생성할 권한이 없습니다. |
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.
데이터셋 두 개를 manual 대상으로 지정한 예제입니다. master는 이 예제에서 명시한 브랜치이며 실제 대상 브랜치와 리소스 RID를 사용합니다. 재시도 1회와 대기 30초도 예제의 설정값입니다.
cURL
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v2/orchestration/builds/create" \
-d '{"abortOnFailure":false,"retryBackoffDuration":{"unit":"SECONDS","value":30},"retryCount":1,"fallbackBranches":[],"branchName":"master","target":{"type":"manual","targetRids":["ri.foundry.main.dataset.4263bdd9-d6bc-4244-9cca-893c1a2aef62","ri.foundry.main.dataset.86939c1e-4256-41db-9fe7-e7ee9e0f752a"]},"notificationsEnabled":false}'
Python
Requests 라이브러리가 설치된 Python 환경에서 사용합니다.
import os
import requests
HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
"content-type": "application/json",
"authorization": "Bearer {}".format(TOKEN)
}
request_body = {'abortOnFailure': False,
'retryBackoffDuration': {'unit': 'SECONDS', 'value': 30},
'retryCount': 1,
'fallbackBranches': [],
'branchName': 'master',
'target': {'type': 'manual',
'targetRids': ['ri.foundry.main.dataset.4263bdd9-d6bc-4244-9cca-893c1a2aef62',
'ri.foundry.main.dataset.86939c1e-4256-41db-9fe7-e7ee9e0f752a']},
'notificationsEnabled': False}
response = requests.post('https://{}/api/v2/orchestration/builds/create'.format(HOSTNAME), headers=headers, json=request_body)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 CreateBuildExample.java 파일에서 사용합니다.
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
public class CreateBuildExample {
public static void main(String[] args) throws Exception {
String HOSTNAME = System.getenv("FOUNDRY_HOST");
String TOKEN = System.getenv("FOUNDRY_TOKEN");
try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v2/orchestration/builds/create");
request.addHeader("content-type", "application/json");
request.addHeader("authorization", String.format("Bearer %s", TOKEN));
request.setEntity(new StringEntity("{\"abortOnFailure\":false,\"retryBackoffDuration\":{\"unit\":\"SECONDS\",\"value\":30},\"retryCount\":1,\"fallbackBranches\":[],\"branchName\":\"master\",\"target\":{\"type\":\"manual\",\"targetRids\":[\"ri.foundry.main.dataset.4263bdd9-d6bc-4244-9cca-893c1a2aef62\",\"ri.foundry.main.dataset.86939c1e-4256-41db-9fe7-e7ee9e0f752a\"]},\"notificationsEnabled\":false}", ContentType.APPLICATION_JSON));
try (CloseableHttpResponse response = httpClient.execute(request)) {
System.out.println(response);
}
}
}
}
JavaScript
fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.
const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;
fetch(`https://${HOSTNAME}/api/v2/orchestration/builds/create`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${TOKEN}`,
},
body: '{"abortOnFailure":false,"retryBackoffDuration":{"unit":"SECONDS","value":30},"retryCount":1,"fallbackBranches":[],"branchName":"master","target":{"type":"manual","targetRids":["ri.foundry.main.dataset.4263bdd9-d6bc-4244-9cca-893c1a2aef62","ri.foundry.main.dataset.86939c1e-4256-41db-9fe7-e7ee9e0f752a"]},"notificationsEnabled":false}'
}).then((response) => {
console.log(response)
});
PowerShell
$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST
$headers = @{
"authorization" = "Bearer $TOKEN"
}
$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/orchestration/builds/create" `
-Method Post `
-Headers $headers `
-ContentType application/json `
-Body "{`"abortOnFailure`":false,`"retryBackoffDuration`":{`"unit`":`"SECONDS`",`"value`":30},`"retryCount`":1,`"fallbackBranches`":[],`"branchName`":`"master`",`"target`":{`"type`":`"manual`",`"targetRids`":[`"ri.foundry.main.dataset.4263bdd9-d6bc-4244-9cca-893c1a2aef62`",`"ri.foundry.main.dataset.86939c1e-4256-41db-9fe7-e7ee9e0f752a`"]},`"notificationsEnabled`":false}"
$response.content