getScannerHistories

VPC 환경에서 이용 가능합니다.

스캐너 실행 이력을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/catalogs/{catalogId}/scanners/{scannerId}/histories

요청 헤더

Data Catalog API에서 공통으로 사용하는 헤더에 대한 정보는 Data Catalog 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`catalogId`	Integer	Required	카탈로그 아이디 getCatalogs 참조
`scannerId`	Integer	Required	스캐너 아이디 getScanners 참조

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`fromTimestamp`	Integer	Required	조회 시작 일시(밀리초) Unix Timestamp 형식
`toTimestamp`	Integer	Required	조회 종료 일시(밀리초) Unix Timestamp 형식
`pageNo`	Integer	Optional	페이지 번호 1~N (기본값: 1)
`pageSize`	Integer	Optional	페이지 출력 수 1~200 (기본값: 20)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/scanners/9**/histories?fromTimestamp=1742338800000&toTimestamp=1742342400000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`pageNo`	Integer	-	페이지 번호
`pageSize`	Integer	-	페이지 출력 수
`totalCount`	Integer	-	응답 결과 수
`scannerHistoryListResponseList`	Array	-	실행 이력 목록

`scannerHistoryListResponseList`

scannerHistoryListResponseList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`scannerId`	Integer	-	스캐너 아이디
`catalogId`	Integer	-	카탈로그 아이디
`beginTime`	String	-	스캔 시작 일시 ISO 8601 형식
`endTime`	String	-	스캔 종료 일시 ISO 8601 형식
`result`	String	-	스캐너 실행 결과 `SUCCESS` \| `FAIL` \| `CANCEL` `SUCCESS`: 성공 `FAIL`: 실패 `CANCEL`: 취소
`resultMessage`	String	-	실행 결과 메시지 `result`가 `FAIL` 또는 `CANCEL`인 경우, 표시
`tableChanges`	String	-	스캔 결과로 추가되거나 변경된 테이블 및 파티션 정보 `result`가 `SUCCESS`인 경우, 표시
`elapsedTime`	Integer	-	스캐너 실행 시간(초)
`createTime`	String	-	이력 생성 일시 ISO 8601 형식

응답 상태 코드

Data Catalog API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Data Catalog 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 3,
    "scannerHistoryListResponseList": [
        {
            "scannerId": 9**,
            "catalogId": 4**,
            "beginTime": "2025-03-19T08:50:45+0900",
            "endTime": "2025-03-19T08:50:50+0900",
            "result": "FAIL",
            "resultMessage": "scanner finished with error",
            "elapsedTime": 5,
            "createTime": "2025-03-19T08:50:51+0900"
        },
        {
            "scannerId": 9**,
            "catalogId": 4**,
            "beginTime": "2025-03-19T08:49:36+0900",
            "endTime": "2025-03-19T08:49:41+0900",
            "result": "FAIL",
            "resultMessage": "scanner finished with error",
            "elapsedTime": 5,
            "createTime": "2025-03-19T08:49:42+0900"
        },
        {
            "scannerId": 9**,
            "catalogId": 4**,
            "beginTime": "2025-03-19T08:43:44+0900",
            "endTime": "2025-03-19T08:43:50+0900",
            "result": "SUCCESS",
            "tableChanges": "{\"table_added\": {\"count\": 1, \"list\": [\"library_books_csv\"]}, \"table_updated\": {\"count\": 0, \"list\": []}, \"table_failed\": {\"count\": 0, \"list\": []}, \"partition_added\": {\"count\": 0, \"list\": []}, \"partition_updated\": {\"count\": 0, \"list\": []}, \"partition_failed\": {\"count\": 0, \"list\": []}}",
            "elapsedTime": 6,
            "createTime": "2025-03-19T08:43:50+0900"
        }
    ]
}