Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

데이터셋 일정 조회(Get Dataset Schedules) (V2)

데이터셋을 대상으로 하는 일정(Schedule)의 RID를 조회합니다. branchName을 생략하면 기본 브랜치를 사용합니다.

최근 일정 변경이 응답에 나타나는 데 최대 한 시간이 걸릴 수 있으며 Marketplace가 관리하는 일정에서는 특히 지연될 수 있습니다. 그동안 이전 결과를 반환할 수 있으므로 즉시 변경 확인이 필요한 작업에서 이 응답만으로 반영 여부를 판단하지 않습니다.

HTTP 요청

GET /api/v2/datasets/{datasetRid}/getSchedules

작업 식별자는 v2.getDatasetSchedules입니다. OAuth 클라이언트에는 api:orchestration-read, api:datasets-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
datasetRidstring필수작업 대상 데이터셋의 RID입니다.ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
branchNamestring선택브랜치 이름입니다. 생략하면 기본 브랜치를 사용하며 대부분의 플랫폼 인스턴스에서는 master입니다.master
pageSizeinteger선택요청할 페이지 크기입니다. 실제 반환 건수에는 공통 페이징 규칙을 적용합니다.
pageTokenstring선택첫 요청에서는 생략합니다. 다음 요청에는 이전 응답의 nextPageToken을 넣습니다.

요청 본문

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

응답

응답 형식은 ListSchedulesResponse입니다.

이름자료형필수 여부의미와 조건예시 값
datalist<ScheduleRid>선택현재 페이지의 일정 RID 목록입니다.
nextPageTokenstring선택다음 페이지를 요청할 토큰입니다. 다음 요청의 pageToken으로 전달합니다.

가상 데이터셋을 대상으로 하는 일정 RID 목록의 응답 예시입니다.

{
  "data": [
    "ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871"
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
BranchNotFoundNOT_FOUND404브랜치를 찾을 수 없거나 토큰이 접근할 수 없습니다.datasetRid, branchName
DatasetNotFoundNOT_FOUND404데이터셋을 찾을 수 없거나 토큰이 접근할 수 없습니다.datasetRid
GetDatasetSchedulesPermissionDeniedPERMISSION_DENIED403데이터셋의 일정 조회 권한이 거부되었습니다.datasetRid

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 아래 RID, 이름과 파일 경로는 예시이며 실제 작업 대상으로 바꾸어야 합니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getSchedules?branchName=master"

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/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getSchedules?branchName=master'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 GetDatasetSchedulesExample.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 GetDatasetSchedulesExample {
    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/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getSchedules?branchName=master");
            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/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getSchedules?branchName=master`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).then((response) => {
    console.log(response)
});

PowerShell

$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getSchedules?branchName=master" `
	-Headers $headers

$response.content