프로젝트에 리소스 참조 추가(Add Project Resource References) (V2)

프로젝트 밖의 리소스를 대상 프로젝트의 참조로 추가합니다. 파일시스템 리소스에는 filesystem, Spark 프로필이나 LLM 모델처럼 파일시스템 밖의 리소스에는 external을 사용합니다.

외부 참조는 resourceRid와 사용자 지정 레이블인 importName이 필요합니다. 파일시스템 참조는 resourceRid를 지정합니다. 원본 리소스와 목적지 프로젝트의 권한을 확인하며, 참조를 추가하는 작업 자체가 원본의 접근 권한을 부여하지는 않습니다.

HTTP 요청

POST /api/v2/filesystem/projects/{projectRid}/references/add

작업 식별자는 v2.addProjectResourceReferences입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:filesystem-write 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

쿼리 매개변수

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

요청 본문

AddProjectResourceReferencesRequest 본문은 필수입니다. resources의 항목은 아래 두 구분자 객체입니다. 조회 결과의 reference 래퍼와 가져온 시각 및 사용자 필드를 복사하여 넣는 형태와 구분합니다.

resources의 구조

배열 항목은 AddResourceReferenceRequest이며 자료형은 union<external, filesystem>입니다.

리소스를 프로젝트의 참조로 추가하는 입력입니다.

분기 external

파일시스템 밖의 리소스를 프로젝트 참조로 추가하는 입력입니다.

분기 filesystem

파일시스템 리소스를 프로젝트 참조로 추가하는 입력입니다.

다음 본문의 식별자와 값은 가상 예시입니다.

{
  "resources": [
    {
      "type": "filesystem",
      "resourceRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
    },
    {
      "type": "external",
      "resourceRid": "ri.spark-configuration-service.main.spark-profile.EXECUTOR_MEMORY_LARGE",
      "importName": "EXECUTOR_MEMORY_LARGE"
    }
  ]
}

응답

성공 응답에 반환할 본문 모델이 없습니다.

개별 오류

요청 예제

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

데이터셋 참조와 Spark 프로필 참조를 함께 추가하는 입력 예시입니다. 실제로 접근할 수 있는 원본 RID와 목적지 프로젝트를 사용하고 외부 참조 레이블도 해당 프로젝트의 용도에 맞게 정합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references/add" \
	-d '{"resources":[{"type":"filesystem","resourceRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"},{"type":"external","resourceRid":"ri.spark-configuration-service.main.spark-profile.EXECUTOR_MEMORY_LARGE","importName":"EXECUTOR_MEMORY_LARGE"}]}'

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
request_body = {
    "resources": [
        {
            "type": "filesystem",
            "resourceRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
        },
        {
            "type": "external",
            "resourceRid": "ri.spark-configuration-service.main.spark-profile.EXECUTOR_MEMORY_LARGE",
            "importName": "EXECUTOR_MEMORY_LARGE"
        }
    ]
}

response = requests.post('https://{}/api/v2/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references/add'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

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

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;

public class AddProjectResourceReferencesExample {
    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()) {
            HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v2/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references/add");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"resources\":[{\"type\":\"filesystem\",\"resourceRid\":\"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da\"},{\"type\":\"external\",\"resourceRid\":\"ri.spark-configuration-service.main.spark-profile.EXECUTOR_MEMORY_LARGE\",\"importName\":\"EXECUTOR_MEMORY_LARGE\"}]}", ContentType.APPLICATION_JSON));
            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/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references/add`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"resources":[{"type":"filesystem","resourceRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"},{"type":"external","resourceRid":"ri.spark-configuration-service.main.spark-profile.EXECUTOR_MEMORY_LARGE","importName":"EXECUTOR_MEMORY_LARGE"}]}'
}).then((response) => {
    console.log(response)
});

PowerShell

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

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

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references/add" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"resources`":[{`"type`":`"filesystem`",`"resourceRid`":`"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`"},{`"type`":`"external`",`"resourceRid`":`"ri.spark-configuration-service.main.spark-profile.EXECUTOR_MEMORY_LARGE`",`"importName`":`"EXECUTOR_MEMORY_LARGE`"}]}"

$response.content