---
title: "Data Catalog 개요"
slug: "analytics-datacatalog"
updated: 2026-09-17T09:16:09Z
published: 2026-09-17T09:16:09Z
canonical: "api.ncloud-docs.com/analytics-datacatalog"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Data Catalog 개요

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분 이상 시간차 발생 시 유효하지 않은 요청으로 간주 - Unix Timestamp 형식 |
| `x-ncp-iam-access-key` | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key - Access Key 발급 및 확인: [인증키 생성](/docs/common-ncpapi) 참조 - 서브 계정의 Access Key 발급 및 확인: [서브 계정 생성](https://guide.ncloud-docs.com/docs/subaccount-use#%EC%84%9C%EB%B8%8C-%EA%B3%84%EC%A0%95-%EC%83%9D%EC%84%B1) 참조 |
| `x-ncp-apigw-signature-v2` | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 - Secret Key 발급 및 확인: [인증키 생성](/docs/common-ncpapi) 참조 - 서명 생성: [시그니처 생성](/docs/common-ncpapi) 참조 |

### 응답

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

#### 응답 바디

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

**responseError**

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

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

#### 응답 상태 코드

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

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

참고

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Ncloud API 응답 상태 코드](/docs/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오.

#### 응답 예시

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

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

## Data Catalog API

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

### Catalog

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

| API | 설명 |
| --- | --- |
| [getCatalogs](/docs/analytics-datacatalog-catalog-getcatalogs) | 카탈로그 조회 |

### Database

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

| API | 설명 |
| --- | --- |
| [getDatabase](/docs/analytics-datacatalog-database-getdatabase) | 데이터베이스 상세 정보 조회 |
| [getDatabases](/docs/analytics-datacatalog-database-getdatabases) | 데이터베이스 목록 조회 |

### Table

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

| API | 설명 |
| --- | --- |
| [getTable](/docs/analytics-datacatalog-table-gettable) | 테이블 상세 정보 조회 |
| [getTablePartitions](/docs/analytics-datacatalog-table-gettablepartitions) | 테이블 파티션 목록 조회 |
| [getTablePartitionKeys](/docs/analytics-datacatalog-table-gettablepartitionkeys) | 테이블 파티션 키 목록 조회 |
| [getTableProperties](/docs/analytics-datacatalog-table-gettableproperties) | 테이블 상세 속성 정보 조회 |
| [getTableSchema](/docs/analytics-datacatalog-table-gettableschema) | 테이블 스키마 목록 조회 |
| [getTableSchemaAndPartitionKeys](/docs/analytics-datacatalog-table-gettableschemaandpartitionkeys) | 테이블 스키마 및 파티션 키 목록 조회 |
| [getTableSchemaByVersion](/docs/analytics-datacatalog-table-gettableschemabyversion) | 테이블 스키마 버전 상세 정보 조회 |
| [getTableSchemaVersions](/docs/analytics-datacatalog-table-gettableschemaversions) | 테이블 스키마 버전 목록 조회 |
| [getTableTags](/docs/analytics-datacatalog-table-gettabletags) | 테이블 태그 목록 조회 |
| [getTables](/docs/analytics-datacatalog-table-gettables) | 카탈로그 내 테이블 목록 조회 |
| [getTablesByDatabase](/docs/analytics-datacatalog-table-gettablesbydatabase) | 데이터베이스 내 테이블 목록 조회 |

### Scanner

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

| API | 설명 |
| --- | --- |
| [getScanner](/docs/analytics-datacatalog-scanner-getscanner) | 스캐너 상세 정보 조회 |
| [getScannerHistories](/docs/analytics-datacatalog-scanner-getscannerhistories) | 스캐너 실행 이력 조회 |
| [getScanners](/docs/analytics-datacatalog-scanner-getscanners) | 스캐너 목록 조회 |
| [runScanner](/docs/analytics-datacatalog-scanner-runscanner) | 스캐너 실행 |
| [stopScanner](/docs/analytics-datacatalog-scanner-stopscanner) | 스캐너 실행 중지 |

### Connection

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

| API | 설명 |
| --- | --- |
| [getConnection](/docs/analytics-datacatalog-connection-getconnection) | 커넥션 상세 정보 조회 |
| [getConnections](/docs/analytics-datacatalog-connection-getconnections) | 커넥션 목록 조회 |

## Data Catalog 연관 리소스

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

- Data Catalog API 사용 방법
  - [서명(시그니처) 생성](/docs/common-ncpapi): 요청 헤더에 추가할 서명 생성 방법
  - [API Gateway 사용 가이드](https://guide.ncloud-docs.com/docs/apigw-apigw-1): 요청 헤더에 추가할 API Key 발급
  - [Sub Account 사용 가이드](https://guide.ncloud-docs.com/docs/subaccount-overview): 요청 헤더에 추가할 Access Key 발급 방법
  - [Ncloud 공통 응답 상태 코드](/docs/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C): Data Catalog 서비스에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보
- Data Catalog 서비스 사용 방법
  - [Data Catalog 사용 가이드](https://guide.ncloud-docs.com/docs/datacatalog-overview): 네이버 클라우드 플랫폼 콘솔에서 Data Catalog 사용하는 방법
  - [Ncloud 사용 환경 가이드](https://guide.ncloud-docs.com/docs/environment-environment-1-1): VPC, Classic 환경 및 지원 여부에 대한 가이드
  - [요금 소개, 특징, 상세 기능](https://www.ncloud.com/product/analytics/dataCatalog): Data Catalog의 요금 체계, 특징, 상세 기능 요약
  - [서비스 최신 소식](https://www.ncloud.com/intro/news): Data Catalog 서비스 관련 최신 소식
  - [자주 하는 질문](https://www.ncloud.com/support/faq/prod?categoryCode2=ANALY&categoryCode3=SV_0226&page=1): Data Catalog 서비스 사용자들이 자주 하는 질문
  - [문의하기](https://www.ncloud.com/support/question/general): API 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의