getScanner
- 인쇄
- PDF
getScanner
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VPC 환경에서 이용 가능합니다.
사용자 Catalog의 특정 Scanner ID에 해당하는 Scanner를 조회합니다.
요청
요청 URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/scanners/{scanner-id}
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| catalogId | Yes | String | catalog 고유 ID (getCatalogs 참고) | |
| scannerId | Yes | String | scanner 고유 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}"
응답
응답 바디
| 항목 | 타입 | 설명 |
|---|---|---|
| scannerId | Integer | Scanner 고유 ID |
| name | String | Scanner 이름 |
| description | String | Scanner 설명 |
| type | String | Scanner 유형 |
| status | String | Scanner 상태(실행 대기/실행 시작/실행 중/실행 종료) |
| location | String | 스캔할 위치 |
| schedule | String | cron expression |
| scheduleType | String | 실행주기(온디멘트/매일/ 매주/매월/크론) |
| opAddType | String | (스키마 추가 시) 테이블 정의 업데이트/새 열만 추가/무시 |
| opDelType | String | DEL_NO로 고정값 |
| includePattern | String | 스캔 대상 포함 패턴 |
| excludePattern | String | 스캔 대상 제외 패턴 |
| tablePrefixName | String | Scanner가 실행되어 출력할 데이터의 Prefix 문자 |
| lastExecStartTime | Date | Scanner 마지막 실행 시작 시간 |
| lastExecElapsedTime | Integer | Scanner 마지막 실행에 대한 실행 시간(초) |
| lastResult | String | Scanner 마지막 실행에 대한 결과 |
| isSchedulePaused | Integer | 실행주기 일시 중지 여부 |
| catalogId | Integer | 사용자 Catalog 고유 ID |
| connectionId | Integer | Connection 고유 ID |
| connectionName | String | Connection 이름 |
| classifierResponseList | json | Scanner의 실행 옵션으로 적용된 분류자 리스트 정보 |
| databaseName | String | Scanner가 실행되어 출력할 데이터의 데이터베이스 |
| createTime | Date | Connection 생성 일시 |
| updateTime | Date | Cfonnection 수정 일시 |
| lastHistoryUuid | String | 마지막 스캔 이력 UUID |
응답 예시
HTTP
| HTTP Status | Description |
|---|---|
| 200 | OK |
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"
}
이 문서가 도움이 되었습니까?