getScannerHistories
    • PDF

    getScannerHistories

    • PDF

    기사 요약

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

    사용자 catalog의 특정 scanner 실행 이력을 확인합니다.

    요청

    요청 URL

    GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/scanners/{scanner-id}/histories
    

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    catalogIdYesStringcatalog 고유 id
    (ref: getCatalogs)
    scannerIdYesStringscanner 고유 id
    fromTimestampYesLong이력을 확인할 시작시간 (milliseconds timestamp)
    toTimestampYesLong이력을 확인할 종료시간 (milliseconds timestamp)
    pageNoNoint페이지 번호기본값: 1
    pageSizeNoint최대값: 200결과 목록 크기기본값: 20

    요청 헤더

    공통 가이드 참조

    요청 예시

    curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/scanners/{scanner-id}/histories?fromTimestamp=1673794800000&toTimestamp=1686841200000" \
        -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}" \
        -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"  \
        -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
    
    • fromTimestamp: 1673794800000 (2023년 1월 16일 오전 12:00:00)
      • GMT: 2023년 1월 15일 오후 3:00:00
    • toTimestamp: 1686841200000 (2023년 6월 16일 오전 12:00:00)
      • GMT: 2023년 6월 15일 오후 3:00:00

    응답

    응답 바디

    • scannerHistoryListResponseList: scanner 실행이력 리스트
    항목타입설명
    scannerIdintscanner 고유 id
    catalogIdint사용자 catalog 고유 id
    beginTimeDatescanner 실행 시작시간
    endTimeDatescanner 실행 종료시간
    resultStringscanner 실행 결과에 대한 성공/실패
    resultMessageStringscanner 실행 결과에 대한 메세지
    tableChangesStringscanner 실행 결과에 따라 추가/변경된 테이블, 추가/변경된 파티션 정보
    elapsedTimeintscanner 실행에 걸린 시간
    createTimeDatescanner 생성 시간

    응답 예시

    HTTP

    HTTP StatusDescription
    200OK

    JSON

    {
      "pageNo": 1,
      "pageSize": 1,
      "totalCount": 1,
      "scannerHistoryListResponseList": [
        {
          "scannerId": 89,
          "catalogId": 301,
          "beginTime": "2023-05-25T10:38:49+0900",
          "endTime": "2023-05-25T10:38:56+0900",
          "result": "SUCCESS",
          "resultMessage": "",
          "tableChanges": "{\"table_added\": {\"count\": 0, \"list\": []}, \"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": 5,
          "createTime": "2023-05-25T10:38:56+0900"
        }
      ]
    }
    

    이 문서가 도움이 되었습니까?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.