getScanner
    • PDF

    getScanner

    • PDF

    기사 요약

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

    사용자 Catalog의 특정 Scanner ID에 해당하는 Scanner를 조회합니다.

    요청

    요청 URL

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

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    catalogIdYesStringcatalog 고유 ID
    (getCatalogs 참고)
    scannerIdYesStringscanner 고유 ID

    요청 헤더

    공통 가이드 참조

    요청 예시

    curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/scanners/{scanner-id}" \
        -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}"
    

    응답

    응답 바디

    항목타입설명
    scannerIdIntegerScanner 고유 ID
    nameStringScanner 이름
    descriptionStringScanner 설명
    typeStringScanner 유형
    statusStringScanner 상태(실행 대기/실행 시작/실행 중/실행 종료)
    locationString스캔할 위치
    scheduleStringcron expression
    scheduleTypeString실행주기(온디멘트/매일/ 매주/매월/크론)
    opAddTypeString(스키마 추가 시) 테이블 정의 업데이트/새 열만 추가/무시
    opDelTypeStringDEL_NO로 고정값
    includePatternString스캔 대상 포함 패턴
    excludePatternString스캔 대상 제외 패턴
    tablePrefixNameStringScanner가 실행되어 출력할 데이터의 Prefix 문자
    lastExecStartTimeDateScanner 마지막 실행 시작 시간
    lastExecElapsedTimeIntegerScanner 마지막 실행에 대한 실행 시간(초)
    lastResultStringScanner 마지막 실행에 대한 결과
    isSchedulePausedInteger실행주기 일시 중지 여부
    catalogIdInteger사용자 Catalog 고유 ID
    connectionIdIntegerConnection 고유 ID
    connectionNameStringConnection 이름
    classifierResponseListjsonScanner의 실행 옵션으로 적용된 분류자 리스트 정보
    databaseNameStringScanner가 실행되어 출력할 데이터의 데이터베이스
    createTimeDateConnection 생성 일시
    updateTimeDateCfonnection 수정 일시
    lastHistoryUuidString마지막 스캔 이력 UUID

    응답 예시

    HTTP

    HTTP StatusDescription
    200OK

    JSON

    {
      "scannerId": 89,
      "name": "datacatalog-test-scanner",
      "description": "",
      "type": "OBJECT_STORAGE",
      "status": "SCANNER_IDLE",
      "location": "datacatalog-test",
      "schedule": "",
      "scheduleType": "ON_DEMAND",
      "opAddType": "UPDATE_TABLE",
      "opDelType": "DEL_NO",
      "includePattern": "",
      "excludePattern": "",
      "tablePrefixName": "",
      "lastExecStartTime": "2023-06-16T10:45:54+0900",
      "lastExecElapsedTime": 6,
      "lastResult": "SUCCESS",
      "isSchedulePaused": 0,
      "catalogId": 301,
      "connectionId": 87,
      "connectionName": "datacatalog-test-conn",
      "classifierResponseList": [
        {
          "disabled": false,
          "classifierId": 30,
          "catalogId": 301,
          "name": "datacatalog-json-classier",
          "type": "JSON",
          "value": "$.store.book[*]",
          "createTime": "2022-12-05T10:07:08+0900"
        },
        {
          "disabled": false,
          "classifierId": 31,
          "catalogId": 301,
          "name": "datacatalog-csv-classier",
          "type": "CSV",
          "value": ",",
          "createTime": "2023-04-17T08:14:45+0900"
        }
      ],
      "databaseName": "datacatalog-scan-db",
      "createTime": "2023-05-19T20:12:26+0900",
      "updateTime": "2023-06-16T10:46:15+0900",
      "lastHistoryUuid": do5sxpiAs"
    }
    

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

    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.