파일 목록(List Files)

데이터셋 파일의 목록을 조회합니다. 기본값은 기본 브랜치의 최신 뷰이며, 대부분의 플랫폼 인스턴스에서 기본 브랜치 이름은 master입니다.

브랜치와 트랜잭션 범위

범위의 시작과 끝 트랜잭션은 같은 루트에서 말단으로 이어지는 경로에 있어야 합니다. 다른 경로에 있을 때의 동작은 정의되어 있지 않습니다. 범위 중간의 스냅샷 트랜잭션은 그때까지 뷰에 누적된 파일을 제거합니다.

다른 데이터셋으로 구성된 가상 뷰는 지원하지 않습니다. 결과는 페이지로 나누며 기본 페이지 크기는 1,000입니다. 반환된 nextPageToken을 다음 요청의 pageToken으로 전달합니다.

HTTP 요청

GET /api/v1/datasets/{datasetRid}/files

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

경로 매개변수

쿼리 매개변수

요청 본문

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

응답

응답 형식은 ListFilesResponse입니다.

가상 데이터셋의 파일 목록과 다음 페이지 토큰을 담은 응답 예시입니다.

{
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z",
  "data": [
    {
      "path": "q3-data/my-file.csv",
      "transactionRid": "ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d",
      "sizeBytes": "74930",
      "updatedTime": "2022-10-10T16:44:55.192Z"
    },
    {
      "path": "q2-data/my-file.csv",
      "transactionRid": "ri.foundry.main.transaction.d8db1cfc-9f8b-4bad-9d8c-00bd818a37c5",
      "sizeBytes": "47819",
      "updatedTime": "2022-07-12T10:12:50.919Z"
    },
    {
      "path": "q2-data/my-other-file.csv",
      "transactionRid": "ri.foundry.main.transaction.d8db1cfc-9f8b-4bad-9d8c-00bd818a37c5",
      "sizeBytes": "55320",
      "updatedTime": "2022-07-12T10:12:46.112Z"
    }
  ]
}

개별 오류

요청 예제

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

아래 예제는 branchId=master인 브랜치 뷰를 조회합니다. 트랜잭션 범위를 조회하려면 브랜치 인수 대신 해당 범위 인수를 사용합니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/files?branchId=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/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/files?branchId=master'.format(HOSTNAME), headers=headers)
print(response)

Java

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

$response.content