Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

스케줄 버전 조회(Get Schedule Version) (V2)

특정 스케줄 버전 RID로 당시의 트리거, 액션과 실행 범위를 조회합니다. 버전은 자체 생성 시각과 생성 사용자를 가지며 원래 스케줄의 RID도 반환합니다.

현재 스케줄 정보가 필요하면 버전의 부모 스케줄 조회를 사용합니다.

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

HTTP 요청

GET /api/v2/orchestration/scheduleVersions/{scheduleVersionRid}

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
scheduleVersionRidstring필수스케줄 버전의 RID입니다.ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017

쿼리 매개변수

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

요청 본문

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

응답

응답 형식은 ScheduleVersion입니다.

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

스케줄 버전의 응답 예시입니다.

{
  "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
  "scheduleRid": "ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871",
  "createdTime": "2024-09-25T17:29:35.974Z",
  "action": {
    "abortOnFailure": false,
    "forceBuild": false,
    "retryBackoffDuration": {
      "unit": "SECONDS",
      "value": 30
    },
    "retryCount": 1,
    "fallbackBranches": [],
    "branchName": "master",
    "notificationsEnabled": false,
    "target": {
      "type": "manual",
      "targetRids": [
        "ri.foundry.main.dataset.b737e24d-6b19-43aa-93d5-da9fc4073f6e",
        "ri.foundry.main.dataset.d2452a94-a755-4778-8bfc-a315ab52fc43"
      ]
    }
  },
  "trigger": {
    "type": "time",
    "cronExpression": "0 0 * * *",
    "timeZone": "UTC"
  },
  "rid": "ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017",
  "scopeMode": {
    "type": "user"
  }
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
ScheduleVersionNotFoundNOT_FOUND404스케줄 버전을 찾을 수 없습니다.scheduleVersionRid

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/orchestration/scheduleVersions/ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017?preview=true"

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/scheduleVersions/ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017?preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetScheduleVersionExample.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 GetScheduleVersionExample {
    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/scheduleVersions/ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017?preview=true");
            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/scheduleVersions/ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017?preview=true`, {
    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/scheduleVersions/ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017?preview=true" `
	-Headers $headers

$response.content