여러 연결의 구성 조회(Get Configuration Connections Batch) (V2)

최대 200개 연결의 구성을 한 번에 조회합니다. 본문에 connectionRid를 가진 항목들의 배열을 보내면 연결 RID와 구성을 대응시킨 맵을 반환합니다.

연결이 없거나 호출 토큰에 필요한 권한이 없으면 해당 항목은 응답에서 제외됩니다. 응답 누락만으로 연결이 삭제되었다고 단정하지 않습니다. POST를 사용하지만 연결 구성을 읽는 작업입니다.

HTTP 요청

POST /api/v2/connectivity/connections/getConfigurationBatch

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

경로 매개변수

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

쿼리 매개변수

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

요청 본문

본문 형식은 list<GetConfigurationConnectionsBatchRequestElement>이며 필수입니다.

배열 항목은 GetConfigurationConnectionsBatchRequestElement이며 자료형은 object입니다.

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

[
  {
    "connectionRid": "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b"
  }
]

응답

응답 형식은 GetConfigurationConnectionsBatchResponse이며, data는 map<ConnectionRid, ConnectionConfiguration>입니다. 요청 순서의 배열 대신 연결 RID를 키로 사용하여 결과를 대응시킵니다.

data의 구조

맵의 키는 ConnectionRid(string), 값은 ConnectionConfiguration(union<s3, rest, snowflake, databricks, smb, jdbc>)입니다.

키: 소스라고도 부르는 Connection의 RID입니다.

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

가상 연결 구성 배치의 응답 예시입니다.

{
  "data": {
    "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b": {
      "type": "jdbc",
      "url": "jdbc:postgresql://db.example.com:5432/example",
      "driverClass": "org.postgresql.Driver"
    }
  }
}

개별 오류

오류 응답 처리는 공통 API 오류 계약을 따릅니다.

요청 예제

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

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/connectivity/connections/getConfigurationBatch" \
	-d '[{"connectionRid":"ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b"}]'

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 = [
    {
        "connectionRid": "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b"
    }
]

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

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetConfigurationConnectionsBatchExample.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 GetConfigurationConnectionsBatchExample {
    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/getConfigurationBatch");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("[{\"connectionRid\":\"ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b\"}]", 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/getConfigurationBatch`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '[{"connectionRid":"ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b"}]'
}).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/getConfigurationBatch" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "[{`"connectionRid`":`"ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b`"}]"

$response.content