Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

트랜잭션 조회(Get Transaction)

데이터셋에 속한 트랜잭션을 RID로 조회합니다. 응답에서 트랜잭션 유형, OPEN, COMMITTED, ABORTED 상태, 생성 시각과 선택적인 종료 시각을 확인합니다.

HTTP 요청

GET /api/v1/datasets/{datasetRid}/transactions/{transactionRid}

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
datasetRidstring필수작업 대상 데이터셋의 RID입니다.ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da
transactionRidstring필수트랜잭션의 RID입니다.ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496

쿼리 매개변수

지정할 쿼리 매개변수가 없습니다.

요청 본문

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

응답

응답 형식은 Transaction입니다.

이름자료형필수 여부의미와 조건예시 값
ridstring필수트랜잭션의 RID입니다.ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4
transactionTypeenum필수트랜잭션의 유형입니다. 허용 값은 APPEND, UPDATE, SNAPSHOT, DELETE입니다.APPEND
statusenum필수트랜잭션 상태입니다. 허용 값: ABORTED, COMMITTED, OPEN.
createdTimestring (ISO 8601)필수트랜잭션 생성 시각이며 ISO 8601 형식입니다.
closedTimestring (ISO 8601)선택트랜잭션 종료 시각이며 ISO 8601 형식입니다.

가상 데이터셋의 열린 트랜잭션을 조회한 응답 예시입니다.

{
  "rid": "ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496",
  "transactionType": "SNAPSHOT",
  "status": "OPEN",
  "createdTime": "2022-10-10T12:20:15.166Z"
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
TransactionNotFoundNOT_FOUND404데이터셋에서 트랜잭션을 찾을 수 없거나 토큰이 접근할 수 없습니다.datasetRid, transactionRid
DatasetNotFoundNOT_FOUND404데이터셋을 찾을 수 없거나 토큰이 접근할 수 없습니다.datasetRid

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496"

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/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 GetTransactionExample.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 GetTransactionExample {
    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/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496");
            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/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496`, {
    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/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496" `
	-Headers $headers

$response.content