Data Catalog 개요

Prev Next

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

Data Catalog는 데이터 자산의 활용성을 강화하는 네이버 클라우드 플랫폼의 메타데이터 통합 및 관리 서비스입니다. Data Catalog 서비스에서는 Catalog, Database, Table, Connection, Scanner 기능에 대한 API를 RESTful 형태로 제공합니다.

Data Catalog 공통 설정

Data Catalog API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

요청 API URL은 다음과 같습니다.

https://datacatalog.apigw.ntruss.com

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
x-ncp-apigw-timestamp Required 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
  • API Gateway 서버와 5분 이상 시간차 발생 시 유효하지 않은 요청으로 간주
x-ncp-iam-access-key Required 네이버 클라우드 플랫폼에서 발급받은 Access Key
x-ncp-apigw-signature-v2 Required 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명

응답

공통 응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

responseError

responseError는 API 호출 실패 정보를 정의합니다. responseError에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
error Object - 오류 코드 및 메시지
errorCode Integer - 오류 코드
message String - 오류 메시지

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드 코드 메시지 설명 해결 방법
400 11006 Running Metastore is not found 동작 중인 메타스토어 없음 네이버 클라우드 플랫폼 포털의 문의하기로 문의
400 14443 현재 스캐너 상태에서 허용되지 않는 작업입니다. 요청한 동작이 해당 스캐너 상태에서 허용되지 않음 스캐너 상태 확인 후 호출
404 14440 스캐너를 찾을 수 없습니다. 조회하려는 스캐너 없음 호출 값 다시 확인
참고

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.

{
  "error": {
    "errorCode": "integer",
    "message": "string"
  }
}

Data Catalog API

Data Catalog 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.

Catalog

Catalog 관련 API에 대한 설명은 다음과 같습니다.

API 설명
getCatalogs 카탈로그 조회

Database

Database 관련 API에 대한 설명은 다음과 같습니다.

API 설명
getDatabase 데이터베이스 상세 정보 조회
getDatabases 데이터베이스 목록 조회

Table

Table 관련 API에 대한 설명은 다음과 같습니다.

API 설명
getTable 테이블 상세 정보 조회
getTablePartitions 테이블 파티션 목록 조회
getTablePartitionKeys 테이블 파티션 키 목록 조회
getTableProperties 테이블 상세 속성 정보 조회
getTableSchema 테이블 스키마 목록 조회
getTableSchemaAndPartitionKeys 테이블 스키마 및 파티션 키 목록 조회
getTableSchemaByVersion 테이블 스키마 버전 상세 정보 조회
getTableSchemaVersions 테이블 스키마 버전 목록 조회
getTableTags 테이블 태그 목록 조회
getTables 카탈로그 내 테이블 목록 조회
getTablesByDatabase 데이터베이스 내 테이블 목록 조회

Scanner

Scanner 관련 API에 대한 설명은 다음과 같습니다.

API 설명
getScanner 스캐너 상세 정보 조회
getScannerHistories 스캐너 실행 이력 조회
getScanners 스캐너 목록 조회
runScanner 스캐너 실행
stopScanner 스캐너 실행 중지

Connection

Connection 관련 API에 대한 설명은 다음과 같습니다.

API 설명
getConnection 커넥션 상세 정보 조회
getConnections 커넥션 목록 조회

Data Catalog 연관 리소스

Data Catalog API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.