외부 시스템 연결 생성(Create Connection) (V2)

직접 연결 런타임을 사용하는 새 Connection을 생성합니다. 상위 폴더 RID, 외부 시스템 구성, 비어 있지 않은 표시 이름과 워커가 필요합니다. worker.type에는 foundryWorker를 사용합니다. 스키마에 나타나는 unknownWorker는 연결 생성이나 갱신 입력으로 사용할 수 없습니다.

요청 본문의 비밀은 TLS로 전송되고 서버에 암호화하여 저장됩니다. 처리 중에는 일시적으로 복호화한 평문이 메모리에 남으며 가비지 컬렉션으로 정리될 때까지 유지됩니다. 이 API를 사용하면 이 메모리 처리의 잠재적 위험을 인정하고 수용하는 조건이 적용됩니다. 이 방식을 원하지 않으면 Foundry UI를 사용합니다.

HTTP 요청

POST /api/v2/connectivity/connections

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

경로 매개변수

지정할 경로 매개변수가 없습니다.

쿼리 매개변수

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

요청 본문

CreateConnectionRequest 본문은 필수입니다. 워커의 외부 통신 정책과 외부 시스템의 접근 조건을 준비한 뒤 요청합니다. 정책 목록을 생략할 수 있다는 스키마 표시를 네트워크 접근의 자동 허용으로 해석하지 않습니다.

configuration의 구조

연결 유형별 생성 입력과 조회 결과의 전체 필드는 연결 구성 자료형을 따릅니다. 암호화 속성은 조회 시 비밀 이름을 반환하며, 생성 입력과 조회 결과가 다른 필드는 해당 연결 유형에서 구분합니다.

worker의 구조

분기 unknownWorker

분기 foundryWorker

networkEgressPolicyRids의 구조

배열 항목은 NetworkEgressPolicyRid이며 자료형은 string입니다.

외부 통신 정책의 RID입니다.

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

{
  "parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
  "configuration": {
    "type": "jdbc",
    "url": "jdbc:postgresql://db.example.com:5432/example",
    "driverClass": "org.postgresql.Driver"
  },
  "displayName": "Connection to my external system",
  "worker": {
    "type": "foundryWorker"
  }
}

응답

생성한 Connection을 반환합니다. exportSettings는 실제 응답값을 확인합니다. 예시의 내보내기 허용 값이 생성 기본값을 뜻하지는 않습니다.

Connection의 필수 메타데이터, 워커와 내보내기 설정은 Connection 자료형을 따릅니다. 외부 시스템별 필드는 연결 구성에서 확인합니다.

가상 JDBC 연결의 응답 예시입니다.

{
  "parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
  "configuration": {
    "type": "jdbc",
    "url": "jdbc:postgresql://db.example.com:5432/example",
    "driverClass": "org.postgresql.Driver"
  },
  "displayName": "Connection to my external system",
  "exportSettings": {
    "exportsEnabled": true,
    "exportEnabledWithoutMarkingsValidation": false
  },
  "rid": "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b",
  "worker": {
    "type": "foundryWorker"
  }
}

개별 오류

요청 예제

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

가상 JDBC 연결을 만드는 예제입니다. db.example.com과 폴더 RID, 표시 이름을 실제 값으로 바꾸고 Foundry 워커에서 접근 가능한 데이터베이스 주소를 사용합니다. 해당 환경에서 필요한 외부 통신 정책 RID를 worker.networkEgressPolicyRids에 지정합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/connectivity/connections" \
	-d '{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","configuration":{"type":"jdbc","url":"jdbc:postgresql://db.example.com:5432/example","driverClass":"org.postgresql.Driver"},"displayName":"Connection to my external system","worker":{"type":"foundryWorker"}}'

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 = {
    "parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
    "configuration": {
        "type": "jdbc",
        "url": "jdbc:postgresql://db.example.com:5432/example",
        "driverClass": "org.postgresql.Driver"
    },
    "displayName": "Connection to my external system",
    "worker": {
        "type": "foundryWorker"
    }
}

response = requests.post('https://{}/api/v2/connectivity/connections'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 CreateConnectionExample.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 CreateConnectionExample {
    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/connectivity/connections");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"parentFolderRid\":\"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791\",\"configuration\":{\"type\":\"jdbc\",\"url\":\"jdbc:postgresql://db.example.com:5432/example\",\"driverClass\":\"org.postgresql.Driver\"},\"displayName\":\"Connection to my external system\",\"worker\":{\"type\":\"foundryWorker\"}}", 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/connectivity/connections`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","configuration":{"type":"jdbc","url":"jdbc:postgresql://db.example.com:5432/example","driverClass":"org.postgresql.Driver"},"displayName":"Connection to my external system","worker":{"type":"foundryWorker"}}'
}).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/connectivity/connections" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"parentFolderRid`":`"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791`",`"configuration`":{`"type`":`"jdbc`",`"url`":`"jdbc:postgresql://db.example.com:5432/example`",`"driverClass`":`"org.postgresql.Driver`"},`"displayName`":`"Connection to my external system`",`"worker`":{`"type`":`"foundryWorker`"}}"

$response.content