상태 검사 생성(Create Check) (V2)

새 상태 검사를 만듭니다. 데이터셋 또는 일정 대상, 검사 유형과 조건을 config에 지정합니다. 같은 대상과 유형의 검사가 이미 있으면 충돌 오류가 발생합니다.

경로 매개변수는 없습니다. 쿼리의 preview는 boolean이며 이 작업을 사용할 때 true로 지정합니다.

요청 본문

필수 CreateCheckRequest의 config는 필수이고, 검사 이유를 설명하는 intent 문자열은 선택 항목입니다. config는 전체 검사 구성의 18개 유형 중 하나입니다. 생성 구성에는 유형별 subject와 필요한 대상 열을 포함합니다.

다음 구성 조건을 충족해야 합니다.

• 시간 및 트랜잭션 시간 검사: timeBounds 또는 medianDeviation 중 하나 이상
• 백분율 검사: percentageBounds 또는 medianDeviation 중 하나 이상
• 수치 열 검사: numericBounds 또는 trend 중 하나 이상
• 추세 검사: trendType 또는 differenceBounds 중 하나 이상

아래 요청은 가상 데이터셋의 최근 빌드 상태를 검사하는 예시입니다. 대상 안의 브랜치 필드는 branchId입니다.

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

HTTP 요청

POST /api/v2/dataHealth/checks

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

JSON 요청 예시

가상 데이터셋에 빌드 상태 검사를 생성하는 요청 예시입니다.

{
  "config": {
    "type": "buildStatus",
    "subject": {
      "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
      "branchId": "master"
    },
    "statusCheckConfig": {
      "severity": "MODERATE",
      "escalationConfig": {
        "failuresToCritical": 1,
        "timeIntervalInSeconds": "30"
      }
    }
  },
  "intent": "Check to ensure builds are passing."
}

응답 구조

응답은 Check입니다. rid와 config는 필수이며, groups, intent, createdBy, updatedTime은 선택 항목입니다.

전체 18개 검사 유형과 중첩 필드, 범위, 추세와 심각도 조건은 검사 구성 자료형을 따릅니다.

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

{
  "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"
      }
    }
  }
}

개별 오류

요청 예제

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/dataHealth/checks?preview=true" \
	-d '{"config":{"type":"buildStatus","subject":{"datasetRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da","branchId":"master"},"statusCheckConfig":{"severity":"MODERATE","escalationConfig":{"failuresToCritical":1,"timeIntervalInSeconds":"30"}}},"intent":"Check to ensure builds are passing."}'

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 = {'config': {'type': 'buildStatus',
            'subject': {'datasetRid': 'ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da',
                        'branchId': 'master'},
            'statusCheckConfig': {'severity': 'MODERATE',
                                  'escalationConfig': {'failuresToCritical': 1,
                                                       'timeIntervalInSeconds': '30'}}},
 'intent': 'Check to ensure builds are passing.'}

response = requests.post('https://{}/api/v2/dataHealth/checks?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 CreateCheckExample.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 CreateCheckExample {
    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/dataHealth/checks?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"config\":{\"type\":\"buildStatus\",\"subject\":{\"datasetRid\":\"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da\",\"branchId\":\"master\"},\"statusCheckConfig\":{\"severity\":\"MODERATE\",\"escalationConfig\":{\"failuresToCritical\":1,\"timeIntervalInSeconds\":\"30\"}}},\"intent\":\"Check to ensure builds are passing.\"}", 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/dataHealth/checks?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: JSON.stringify({"config":{"type":"buildStatus","subject":{"datasetRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da","branchId":"master"},"statusCheckConfig":{"severity":"MODERATE","escalationConfig":{"failuresToCritical":1,"timeIntervalInSeconds":"30"}}},"intent":"Check to ensure builds are passing."})
}).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?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body '{"config":{"type":"buildStatus","subject":{"datasetRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da","branchId":"master"},"statusCheckConfig":{"severity":"MODERATE","escalationConfig":{"failuresToCritical":1,"timeIntervalInSeconds":"30"}}},"intent":"Check to ensure builds are passing."}'

$response.content