Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

스케줄 실행 이력(List Runs Of Schedule) (V2)

스케줄의 최근 실행 건을 조회합니다. pageSize를 생략하면 100을 사용합니다. 이 값은 기본 페이지 크기이며 최대값을 뜻하지 않습니다.

첫 요청에서는 pageToken을 생략하고 반환된 nextPageToken을 다음 요청에 전달합니다. ScheduleRun.result는 트리거 처리 결과이므로 실제 계산 결과는 제출된 빌드의 상태와 구분합니다.

HTTP 요청

GET /api/v2/orchestration/schedules/{scheduleRid}/runs

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
scheduleRidstring필수스케줄의 RID입니다.ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
pageSizeinteger선택요청할 페이지 크기입니다.
pageTokenstring선택페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 nextPageToken을 pageToken으로 전달합니다.

요청 본문

요청 본문을 사용하지 않습니다.

응답

응답 형식은 ListRunsOfScheduleResponse입니다.

이름자료형필수 여부의미와 조건예시 값
datalist<ScheduleRun>선택
nextPageTokenstring선택다음 페이지를 요청할 때 pageToken에 전달할 토큰입니다. 다음 토큰이 없으면 마지막 페이지입니다.

data의 구조

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

전체 필드는 ScheduleRun 모델을 따릅니다.

스케줄 실행 이력의 응답 예시입니다.

{
  "data": [
    {
      "scheduleVersionRid": "ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017",
      "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
      "scheduleRid": "ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871",
      "createdTime": "2024-09-26T00:00:00.000Z",
      "rid": "ri.scheduler.main.run.d2a5e9c6-298d-4788-a71d-42885d7bebb3"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

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

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/orchestration/schedules/ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871/runs"

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.get('https://{}/api/v2/orchestration/schedules/ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871/runs'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListRunsOfScheduleExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class ListRunsOfScheduleExample {
    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()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/orchestration/schedules/ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871/runs");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            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/schedules/ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871/runs`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).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/schedules/ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871/runs" `
	-Headers $headers

$response.content