Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

연결 내보내기 설정 변경(Update Export Settings For Connection) (V2)

해당 연결로 데이터를 내보낼 수 있는지와 보안 표지 검증 없이 내보내기를 허용할지를 변경합니다. Information Security Officer 역할이 있는 사용자만 이 설정을 수정할 수 있습니다. OAuth 권한 범위만으로 이 역할 조건이 충족되는 것은 아닙니다.

일부 대화형 작업은 내보낼 데이터의 보안 표지를 검증할 수 없습니다. exportEnabledWithoutMarkingsValidation을 켜면 데이터가 조직 정책을 준수하는지 확인할 책임을 수용하는 조건이 적용됩니다. 요청 전 두 설정값과 변경 대상을 확인합니다.

HTTP 요청

POST /api/v2/connectivity/connections/{connectionRid}/updateExportSettings

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
connectionRidstring필수소스라고도 부르는 Connection의 RID입니다.ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b

쿼리 매개변수

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

요청 본문

본문 형식은 UpdateExportSettingsForConnectionRequest이며 필수입니다.

이름자료형필수 여부의미와 조건예시 값
exportSettingsobject필수연결의 내보내기 설정입니다.본문 예시 참조

exportSettings의 구조

이름자료형필수 여부의미와 조건예시 값
exportsEnabledboolean필수Foundry 데이터셋을 이 연결로 내보낼 수 있게 합니다.true
exportEnabledWithoutMarkingsValidationboolean필수일부 대화형 작업에서는 내보낼 데이터의 보안 표지를 검증할 수 없습니다. 표지 검증 없이 내보내기를 허용하면 내보내는 데이터가 조직 정책을 준수하는지 확인할 책임을 수용하는 조건이 적용됩니다.false

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

{
  "exportSettings": {
    "exportsEnabled": true,
    "exportEnabledWithoutMarkingsValidation": false
  }
}

응답

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

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
UpdateExportSettingsForConnectionPermissionDeniedPERMISSION_DENIED403연결의 내보내기 설정을 갱신할 수 없습니다.connectionRid
ConnectionNotFoundNOT_FOUND404지정한 연결을 찾을 수 없습니다.connectionRid

요청 예제

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/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/updateExportSettings" \
	-d '{"exportSettings":{"exportsEnabled":true,"exportEnabledWithoutMarkingsValidation":false}}'

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 = {
    "exportSettings": {
        "exportsEnabled": True,
        "exportEnabledWithoutMarkingsValidation": False
    }
}

response = requests.post('https://{}/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/updateExportSettings'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

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

$response.content