Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

여러 실행 작업 일괄 조회(Get Jobs Batch) (V2)

실행 작업 RID 배열로 최대 500개의 Job을 조회합니다. 응답의 data는 Job RID에서 Job 객체로 대응하는 맵입니다. 빌드 일괄 조회의 100개 한도와 구분합니다.

이 엔드포인트에는 사용자 기준 초당 최대 4회, 동시 요청 최대 25개의 한도가 있습니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

POST /api/v2/orchestration/jobs/getBatch

작업 식별자는 v2.getJobsBatch입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:orchestration-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

지정할 경로 매개변수가 없습니다.

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
previewboolean선택미리보기 기능 사용을 활성화합니다.true

요청 본문

본문 형식은 list<GetJobsBatchRequestElement>이며 필수입니다.

배열 항목은 GetJobsBatchRequestElement이며 자료형은 object입니다.

이름자료형필수 여부의미와 조건예시 값
jobRidstring필수실행 작업의 RID입니다.ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448

다음은 조회할 실행 작업 RID를 지정하는 요청 본문 예시입니다.

[
  {
    "jobRid": "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"
  }
]

응답

응답 형식은 GetJobsBatchResponse입니다.

이름자료형필수 여부의미와 조건예시 값
datamap<JobRid, Job>선택

data의 구조

맵의 키는 JobRid(string), 값은 Job(object)입니다.

키: 실행 작업의 RID입니다.

전체 필드는 Job 응답 모델을 따릅니다.

실행 작업 RID별 조회 결과의 응답 예시입니다.

{
  "data": {
    "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448": {
      "startedTime": "2003-05-06T12:34:56.789Z",
      "jobStatus": "WAITING",
      "buildRid": "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58",
      "rid": "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"
    }
  }
}

개별 오류

오류 응답 처리는 공통 API 오류 계약을 따릅니다.

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/orchestration/jobs/getBatch?preview=true" \
	-d '[{"jobRid":"ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"}]'

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 = [
    {
        "jobRid": "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"
    }
]

response = requests.post('https://{}/api/v2/orchestration/jobs/getBatch?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetJobsBatchExample.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 GetJobsBatchExample {
    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/jobs/getBatch?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("[{\"jobRid\":\"ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448\"}]", 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/jobs/getBatch?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '[{"jobRid":"ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"}]'
}).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/jobs/getBatch?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "[{`"jobRid`":`"ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448`"}]"

$response.content