검사 보고서 조회(Get Check Report) (V2)

검사 RID와 보고서 RID를 함께 지정하여 보고서 한 건을 조회합니다. 보고서의 검사 구성은 실행 당시 스냅샷이며 이후 검사 편집에 따라 바뀌지 않습니다.

요청 본문은 없습니다. 응답은 CheckReport입니다. rid, check, result, createdTime이 모두 필수이며, check의 필수 config와 18개 유형의 중첩 구조는 검사 자료형을 따릅니다. result.status는 필수이고 message는 선택입니다. 상태는 PASSED, FAILED, WARNING, ERROR, NOT_APPLICABLE, NOT_COMPUTABLE 중 하나입니다.

공개 프리뷰이며 쿼리의 preview를 true로 지정해야 합니다. 비운영 개발 용도로 사용하며 사전 통지 없이 변경되거나 제거될 수 있습니다.

HTTP 요청

GET /api/v2/dataHealth/checks/{checkRid}/checkReports/{checkReportRid}

작업 식별자는 v2.getCheckReport입니다. Authorization: Bearer <접근 토큰> 헤더로 인증합니다. OAuth 클라이언트에는 api:data-health-read 권한 범위가 필요합니다.

가상 검사의 실행 시점 구성과 결과를 담은 보고서 예시입니다.

{
  "result": {
    "status": "PASSED"
  },
  "createdTime": "2024-09-25T17:30:00Z",
  "check": {
    "updatedTime": "2024-09-25T17:29:35.974Z",
    "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
    "groups": [
      "ri.data-health.main.check-group.08e376a8-607d-4f44-b8dd-b4587be6ce9b"
    ],
    "rid": "ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3",
    "intent": "Check to ensure builds are passing.",
    "config": {
      "type": "buildStatus",
      "subject": {
        "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
        "branchId": "master"
      },
      "statusCheckConfig": {
        "severity": "MODERATE",
        "escalationConfig": {
          "failuresToCritical": 1,
          "timeIntervalInSeconds": "30"
        }
      }
    }
  },
  "rid": "ri.data-health.main.check-report.a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

개별 오류

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 아래 식별자와 입력값은 예시이므로 실제 요청 대상에 맞게 지정합니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/dataHealth/checks/ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3/checkReports/ri.data-health.main.check-report.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true"

Python

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

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.get('https://{}/api/v2/dataHealth/checks/ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3/checkReports/ri.data-health.main.check-report.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

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

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

public class GetCheckReportExample {
    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()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/dataHealth/checks/ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3/checkReports/ri.data-health.main.check-report.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true");
            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/v2/dataHealth/checks/ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3/checkReports/ri.data-health.main.check-report.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true`, {
    method: 'GET',
    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/v2/dataHealth/checks/ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3/checkReports/ri.data-health.main.check-report.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true" `
	-Headers $headers

$response.content