Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

파일 삭제(Delete File)

데이터셋에서 파일을 삭제합니다. 기본적으로 기본 브랜치에 새 삭제 트랜잭션을 만들어 처리하며, 대부분의 플랫폼 인스턴스에서 기본 브랜치는 master입니다. 과거 뷰에서는 삭제 전 파일을 계속 볼 수 있습니다.

트랜잭션 선택

  • branchId를 지정하면 해당 브랜치에 새 삭제 트랜잭션을 만들고 커밋합니다.
  • 여러 파일을 한 트랜잭션에서 삭제하려면 먼저 DELETE 유형의 트랜잭션을 열고 transactionRid를 지정합니다. 다른 유형의 수동 트랜잭션을 사용하지 않습니다. 삭제 작업을 마친 뒤 별도로 커밋합니다.

HTTP 요청

DELETE /api/v1/datasets/{datasetRid}/files/{filePath}

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
datasetRidstring필수작업 대상 데이터셋의 RID입니다.ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da
filePathstring필수데이터셋 안의 파일 경로입니다. URL에 전달할 때 경로 값을 인코딩합니다.q3-data%2fmy-file.csv

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
branchIdstring선택데이터셋 브랜치의 식별 이름입니다. 생략 시 기본 브랜치를 사용하며 대부분의 플랫폼 인스턴스에서는 master입니다.master
transactionRidstring선택파일을 삭제할 열린 DELETE 트랜잭션 RID입니다.ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4

요청 본문

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

응답

별도 응답 본문이 정의되어 있지 않습니다.

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
InvalidParameterCombinationINVALID_ARGUMENT400각 매개변수는 유효하지만 지정한 조합으로는 사용할 수 없습니다.validCombinations, providedParameters
FileNotFoundOnBranchNOT_FOUND404지정 브랜치에서 파일을 찾을 수 없거나 토큰이 접근할 수 없습니다.datasetRid, branchId, path
CreateTransactionPermissionDeniedPERMISSION_DENIED403데이터셋에 트랜잭션을 만들 권한이 없습니다.datasetRid, branchId
AbortTransactionPermissionDeniedPERMISSION_DENIED403해당 데이터셋의 트랜잭션을 중단할 권한이 없습니다.datasetRid, transactionRid
TransactionNotFoundNOT_FOUND404데이터셋에서 트랜잭션을 찾을 수 없거나 토큰이 접근할 수 없습니다.datasetRid, transactionRid
FileNotFoundOnTransactionRangeNOT_FOUND404지정 트랜잭션 범위에서 파일을 찾을 수 없거나 토큰이 접근할 수 없습니다.datasetRid, startTransactionRid, endTransactionRid, path
OpenTransactionAlreadyExistsCONFLICT409해당 데이터셋 브랜치에 열린 트랜잭션이 있습니다. 브랜치마다 한 번에 하나만 열 수 있습니다.datasetRid, branchId
InvalidBranchIdINVALID_ARGUMENT400브랜치 이름이 비어 있거나 RID 또는 UUID처럼 보입니다. 사용할 수 있는 이름으로 바꿉니다.branchId
BranchNotFoundNOT_FOUND404브랜치를 찾을 수 없거나 토큰이 접근할 수 없습니다.datasetRid, branchId
DatasetNotFoundNOT_FOUND404데이터셋을 찾을 수 없거나 토큰이 접근할 수 없습니다.datasetRid
CommitTransactionPermissionDeniedPERMISSION_DENIED403트랜잭션을 커밋할 권한이 없습니다.datasetRid, transactionRid
InvalidTransactionTypeINVALID_ARGUMENT400트랜잭션 유형이 유효하지 않습니다. SNAPSHOT, UPDATE, APPEND, DELETE 중 사용합니다.datasetRid, transactionRid, transactionType
PutSchemaPermissionDeniedPERMISSION_DENIED403권한 거부 오류입니다. 추가 매개변수는 대상 데이터셋과 브랜치를 식별합니다.datasetRid, branchId
TransactionNotOpenINVALID_ARGUMENT400지정 트랜잭션이 열린 상태가 아닙니다.datasetRid, transactionRid, transactionStatus

요청 예제

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

아래 예제는 브랜치를 지정하여 API가 트랜잭션을 생성하고 커밋하는 방식입니다. 수동으로 연 트랜잭션에는 branchId 및 자동 생성용 옵션 대신 transactionRid를 사용합니다.

cURL

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

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 DeleteFileExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class DeleteFileExample {
    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()) {
            HttpDelete request = new HttpDelete("https://" + HOSTNAME + "/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/files/q3-data%2Fmy-file.csv?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/q3-data%2Fmy-file.csv?branchId=master`, {
    method: 'DELETE',
    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/q3-data%2Fmy-file.csv?branchId=master" `
	-Method Delete `
	-Headers $headers

$response.content