데이터셋 상태 검사 보고서(Get Dataset Health Check Reports) (V2)

데이터셋에 구성된 각 상태 검사의 가장 최근 보고서 하나를 가져옵니다. 데이터셋의 현재 검사 상태를 확인할 때 사용합니다. 검사 목록만 필요하면 Get Dataset Health Checks를 사용합니다. 특정 검사의 최근 보고서 이력은 Get Latest Check Reports에서 최대 100개까지 조회합니다.

공개 프리뷰이며 preview=true가 필요합니다. 비운영 개발 용도로 사용하며 사전 통지 없이 변경되거나 제거될 수 있습니다.

매개변수

요청 본문은 없습니다.

응답

GetHealthCheckReportsResponse.data는 선택적인 map<CheckRid, CheckReport>입니다. 키는 검사 RID, 값은 그 검사의 가장 최근 보고서입니다. 검사가 구성되어 있어도 아직 보고서가 없으면 해당 값은 응답에서 빠집니다.

각 CheckReport에는 보고서 rid, 검사 구성 스냅샷 check, 실행 결과 result, 생성 시각 createdTime이 필수입니다. check에는 필수 rid와 config, 선택적인 groups, intent, createdBy, updatedTime이 있습니다. 보고서를 만든 이후 검사 설정을 바꾸어도 그 보고서 안의 스냅샷은 바뀌지 않습니다.

result.status는 PASSED, FAILED, WARNING, ERROR, NOT_APPLICABLE, NOT_COMPUTABLE 중 하나이며 필수입니다. 결과 설명 message는 선택 항목입니다.

config의 18개 검사 유형과 각 대상, 필수 및 선택 필드, 범위, 추세, 심각도, 예시와 허용 열 유형은 검사 구성과 보고서 자료형에 모두 설명되어 있습니다. 데이터셋 대상 안의 필드 이름은 branchId이며, 이 요청의 쿼리 branchName과 구분합니다.

HTTP 요청

GET /api/v2/datasets/{datasetRid}/getHealthCheckReports

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

JSON 응답 예시

가상 데이터셋의 최근 빌드 상태 검사 보고서 응답 예시입니다.

{
  "data": {
    "ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3": {
      "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에는 유효한 토큰을 환경 변수로 제공합니다. 아래 RID, 이름과 파일 경로는 예시이며 실제 작업 대상으로 바꾸어야 합니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getHealthCheckReports?branchName=master&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/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getHealthCheckReports?branchName=master&preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 GetDatasetHealthCheckReportsExample.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 GetDatasetHealthCheckReportsExample {
    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/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getHealthCheckReports?branchName=master&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/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getHealthCheckReports?branchName=master&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/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getHealthCheckReports?branchName=master&preview=true" `
	-Headers $headers

$response.content