Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

브랜치 트랜잭션 이력(Get Branch Transaction History) (V2)

지정한 데이터셋 브랜치의 트랜잭션 이력을 조회합니다. 전체 이력은 최신 트랜잭션부터 역시간순으로 반환합니다. 기본 페이지 크기는 20이며 최대 50입니다.

공개 프리뷰이므로 preview=true가 필요하며 비운영 개발 용도로 사용합니다. 사전 통지 없이 변경되거나 제거될 수 있습니다.

HTTP 요청

GET /api/v2/datasets/{datasetRid}/branches/{branchName}/transactions

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

경로 매개변수

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

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
pageSizeinteger선택기본값은 20이며 최대 50입니다.
pageTokenstring선택첫 요청에서는 생략합니다. 다음 요청에는 이전 응답의 nextPageToken을 넣습니다.
previewboolean선택프리뷰 기능 사용을 허용하는 값입니다. 이 프리뷰 작업을 호출하려면 true로 지정합니다.true

요청 본문

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

응답

응답 형식은 ListTransactionsResponse입니다.

이름자료형필수 여부의미와 조건예시 값
datalist<Transaction>선택현재 페이지의 트랜잭션 목록입니다.
data[].ridstring필수트랜잭션의 RID입니다.ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4
data[].transactionTypeenum필수트랜잭션 유형입니다. 허용 값: APPEND, UPDATE, SNAPSHOT, DELETE.APPEND
data[].statusenum필수트랜잭션 상태입니다. 허용 값: ABORTED, COMMITTED, OPEN.COMMITTED
data[].createdTimestring (ISO 8601)필수트랜잭션 생성 시각이며 ISO 8601 형식입니다.2020-09-30T14:30:00Z
data[].closedTimestring (ISO 8601)선택트랜잭션 종료 시각이며 ISO 8601 형식입니다.2020-09-30T21:00:00Z
nextPageTokenstring선택다음 페이지를 요청할 토큰입니다. 다음 요청의 pageToken으로 전달합니다.

가상 데이터셋 브랜치의 트랜잭션 이력 응답 예시입니다.

{
  "data": [
    {
      "transactionType": "APPEND",
      "createdTime": "2020-09-30T14:30:00Z",
      "rid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4",
      "closedTime": "2020-09-30T21:00:00Z",
      "status": "COMMITTED"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

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

요청 예제

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

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 GetBranchTransactionHistoryExample.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 GetBranchTransactionHistoryExample {
    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/branches/master/transactions?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/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches/master/transactions?preview=true`, {
    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/branches/master/transactions?preview=true" `
	-Headers $headers

$response.content