Data Catalog 개요
- 인쇄
- PDF
Data Catalog 개요
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VPC 환경에서 이용 가능합니다.
개요
Data Catalog 이용을 신청하면 카탈로그와 기본 제공 데이터베이스가 자동으로 생성됩니다. 데이터베이스는 테이블의 집합으로, 메타데이터를 저장합니다. Database 메뉴에서는 카탈로그의 상태를 확인하고 데이터베이스를 생성 및 관리할 수 있습니다.
공통 설정
API URL
https://datacatalog.apigw.ntruss.com/api/v1/
요청 헤더
헤더명 | 설명 |
---|---|
Content-Type | 요청 Body Content Type을 application/json으로 지정 (POST) |
x-ncp-apigw-timestamp | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 |
x-ncp-iam-access-key | NAVER Cloud Platform에서 발급받은 API Key 또는 IAM에서 발급받은 AccessKey |
x-ncp-apigw-signature-v2 | 위 예제의 Body를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명 HMAC 암호화 알고리즘은 HmacSHA256 사용 |
참고
자세한 내용은 NAVER Cloud Platform API 가이드를 참고해 주십시오.
오퍼레이션
Catalog
API명 | 설명 |
---|---|
getCatalogs | 사용자의 모든 catalog id 조회 |
Connection
API명 | 설명 |
---|---|
getConnections | 사용자 catalog의 모든 connection 조회 |
getConnection | 사용자 catalog의 특정 connection id에 해당하는 connection 조회 |
Scanner
API명 | 설명 |
---|---|
getScanners | 사용자 catalog의 모든 scanner 조회 |
getScanner | 사용자 catalog의 특정 scanner id에 해당하는 scanner 조회 |
getScannerHistories | 사용자 catalog의 특정 scanner 실행이력 확인 |
runScanner | 사용자 catalog의 특정 scanner 실행 |
stopScanner | 사용자 catalog의 실행중인 scanner 중지 |
Database
API명 | 설명 |
---|---|
getDatabases | 사용자 catalog가 가진 모든 database 조회 |
getDatabase | 사용자 catalog의 database 이름으로 특정 database 조회 |
Table
API명 | 설명 |
---|---|
getTables | 사용자 catalog의 모든 table 조회 |
getTable | 사용자 catalog의 database/table 이름으로 특정 table 조회 |
getTablesByDatabase | 사용자 catalog의 database 이름으로 특정 database의 모든 table 조회 |
getTablePartitions | 사용자 catalog의 database/table 이름으로 특정 table의 partition key/value 조회 |
getTableTags | 사용자 catalog의 database/table 이름으로 table의 모든 태그 조회 |
getTableSchema | 사용자 catalog의 database/table 이름으로 특정 table의 schema 조회 |
getTableSchemaVersions | 사용자 catalog의 database/table 이름으로 특정 table의 schema version 조회 |
getTableSchemaByVersion | 사용자 catalog의 database/table 이름, schema version으로 table schema 조회 |
getTableSchemaAndPartitionKeys | 사용자 catalog의 database/table 이름으로 특정 table의 schema/partition key 조회 |
에러 응답 형식
API 요청이 잘못되었거나 처리 도중 오류가 발생하면 HTTP 상태코드로 성공/실패를 반환하고 JSON 형식으로 상세 메시지를 반환합니다.
응답 예시
{
"error": {
"errorCode": "integer",
"message": "string"
}
}
에러 응답
HTTP 상태 | 에러 코드 | 메세지 | 설명 | 해결방안 |
---|---|---|---|---|
400 | 11006 | Running Metastore is not found | 동작중인 metastore 없음 | 고객지원 > 문의하기로 문의 |
400 | 14443 | 현재 스캐너 상태에서 허용되지 않는 작업입니다. | 해당 스캐너 상태에서 허용하지 않는 동작 요청하면 발생 | 스캐너 상태 확인 후 호출 |
404 | 14440 | 스캐너를 찾을 수 없습니다. | 조회하려는 scanner 정보가 없는 경우 | 호출값 재확인 |
이 문서가 도움이 되었습니까?