getScanners

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

카탈로그 내 스캐너 목록을 조회합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`pageNo`	Integer	Optional	페이지 번호 1~N (기본값: 1)
`pageSize`	Integer	Optional	페이지 출력 수 1~200 (기본값: 20)
`searchValue`	String	Optional	검색 키워드 스캐너 이름 또는 설명으로 검색 가능 한글 입력 시 URL 인코딩 필요

요청 예시

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

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/scanners?searchValue=%EB%8F%84%EC%84%9C%EA%B4%80' \
--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	-	응답 결과 수
`scannerResponseList`	Array	-	스캐너 목록

`scannerResponseList`

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

필드	타입	필수 여부	설명
`scannerId`	Integer	-	스캐너 아이디
`name`	String	-	스캐너 이름
`status`	String	-	스캐너 상태 `SCANNER_IDLE` \| `SCANNER_STARTING` \| `SCANNER_RUNNING` \| `SCANNER_STOPPING` \| `SCANNER_DONE` `SCANNER_IDLE`: 실행 대기 `SCANNER_STARTING`: 실행 시작 `SCANNER_RUNNING`: 실행 중 `SCANNER_STOPPING`: 실행 중지 `SCANNER_DONE`: 실행 종료
`description`	String	-	스캐너 설명 값이 존재하는 경우, 표시
`type`	String	-	소스 데이터 유형
`location`	String	-	소스 데이터 경로
`schedule`	String	-	스캐너 실행 주기의 크론 표현식 주기적 실행이 설정된 경우, 표시
`scheduleType`	String	-	스캐너 실행 주기 `ON_DEMAND` \| `EVERY_DAY` \| `EVERY_WEEK` \| `EVERY_MONTH` \| `CRON` `ON_DEMAND`: 온디맨드 (사용자 요청 시) `EVERY_DAY`: 매일 `EVERY_WEEK`: 매주 `EVERY_MONTH`: 매월 `CRON`: 크론
`opAddType`	String	-	스키마 추가 시 수집 옵션 `UPDATE_TABLE` \| `ADD_NEW_COLUMNS_ONLY` \| `IGNORE_UPDATE` `UPDATE_TABLE`: 테이블 정의 업데이트 `ADD_NEW_COLUMNS_ONLY`: 새 열만 추가 `IGNORE_UPDATE`: 무시
`opDelType`	String	-	스키마 삭제 시 옵션 `DEL_NO`: 무시 (유효 값)
`includePattern`	String	-	스캔 대상 포함 패턴
`excludePattern`	String	-	스캔 대상 제외 패턴 제외 패턴이 포함 패턴보다 우선 적용
`tablePrefixName`	String	-	출력 데이터 접두어 값이 존재하는 경우, 표시
`lastExecStartTime`	String	-	스캐너 최근 실행 일시 ISO 8601 형식
`lastExecElapsedTime`	Integer	-	스캐너 최근 실행 시간(초)
`lastResult`	String	-	스캐너 최근 실행 결과
`isSchedulePaused`	Integer	-	실행 주기 일시 중지 여부 `1` \| `0` `1`: 일시 중지 `0`: 일시 중지 안 됨
`catalogId`	Integer	-	카탈로그 아이디
`connectionId`	Integer	-	커넥션 아이디
`databaseName`	String	-	출력 데이터의 데이터베이스 이름
`createTime`	String	-	스캐너 생성 일시 ISO 8601 형식
`updateTime`	String	-	업데이트 일시 ISO 8601 형식
`lastHistoryUuid`	String	-	최근 실행 내역 UUID

응답 상태 코드

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

응답 예시

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

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 7,
    "scannerResponseList": [
        {
            "scannerId": 9**,
            "name": "s_mysql",
            "status": "SCANNER_IDLE",
            "description": "Scanner for my_DB",
            "type": "CLOUD_DB_FOR_MYSQL",
            "location": "tables",
            "schedule": "0 4 * * *",
            "scheduleType": "EVERY_DAY",
            "opAddType": "UPDATE_TABLE",
            "opDelType": "DEL_NO",
            "includePattern": "req_avg_*",
            "excludePattern": "sample/*.json",
            "tablePrefixName": "out_",
            "lastExecStartTime": "2025-03-18T17:15:58+0900",
            "lastExecElapsedTime": 6,
            "lastResult": "SUCCESS",
            "isSchedulePaused": 0,
            "catalogId": 4**,
            "connectionId": 6**,
            "databaseName": "default",
            "createTime": "2025-03-18T14:36:29+0900",
            "updateTime": "2025-03-19T11:21:06+0900",
            "lastHistoryUuid": "********"
        },
        {
            "scannerId": 9**,
            "name": "employee_list",
            "status": "SCANNER_IDLE",
            "description": "employee list",
            "type": "OBJECT_STORAGE",
            "location": "s3a://datacatalog-c***-e******f/my_database/employeeList/",
            "schedule": "0 2 1 * *",
            "scheduleType": "EVERY_MONTH",
            "opAddType": "ADD_NEW_COLUMNS_ONLY",
            "opDelType": "DEL_NO",
            "lastExecStartTime": "2025-03-18T09:40:41+0900",
            "lastExecElapsedTime": 6,
            "lastResult": "SUCCESS",
            "isSchedulePaused": 0,
            "catalogId": 4**,
            "databaseName": "default",
            "createTime": "2025-03-18T09:34:42+0900",
            "updateTime": "2025-03-19T10:18:10+0900",
            "lastHistoryUuid": "********"
        },
        ...
    ]
}