---
title: "Data Catalog overview"
slug: "analytics-datacatalog"
tags: ["Data Catalog"]
updated: 2026-09-17T09:47:59Z
published: 2026-09-17T09:47:59Z
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 overview

Available in VPC

Data Catalog is a NAVER Cloud Platform service that integrates and manages metadata to enhance the usability of data assets. The Data Catalog service provides APIs for catalog, database, table, connection, and scanner features in RESTful form.

## Common Data Catalog settings

The following describes commonly used request and response formats in Data Catalog APIs.

### Request

The following describes the common request format.

#### API URL

The request API URL is as follows:

```
https://datacatalog.apigw.ntruss.com
```

#### Request headers

The following describes the request headers.

| Field | Required | Description |
| --- | --- | --- |
| `x-ncp-apigw-timestamp` | Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. - Request is considered invalid if the timestamp differs from the current time by more than 5 minutes. - Unix timestamp format. |
| `x-ncp-iam-access-key` | Required | Access key issued on NAVER Cloud Platform - Issue and check access key: See [Create authentication key](/docs/en/common-ncpapi). - Issue and check access key for sub account: See [Create sub account](https://guide.ncloud-docs.com/docs/en/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 | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256) - Issue and check secret key: See [Create authentication key](/docs/en/common-ncpapi). - Create signature: See [Create signature](/docs/en/common-ncpapi). |

### Response

The following describes the common response format.

#### Response body

The response body includes the following data:

**responseError**

responseError defines the API call failure information. The following describes responseError.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `error` | Object | - | Error code and message |
| `errorCode` | Integer | - | Errors |
| `message` | String | - | Error message |

#### Response status codes

The following describes the response status codes.

| HTTP status code | Code | Message | Description | Solution |
| --- | --- | --- | --- | --- |
| 400 | 11006 | Running Metastore is not found | No metastores in operation | Inquire via [Contact us](https://www.ncloud.com/support/question/service) in the NAVER Cloud Platform portal. |
| 400 | 14443 | The operation is not allowed in the current scanner status. | Request action not allowed in the current scanner status. | Check scanner status before calling. |
| 404 | 14440 | The scanner can't be found. | No scanner found. | Check call value again. |

Note

For response status codes common to NAVER Cloud Platform, see [Ncloud API response status codes](/docs/en/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C).

#### Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

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

## Data Catalog API

The following describes the APIs provided by the Data Catalog service.

### Catalog

The following describes the catalog-related APIs.

| API | Description |
| --- | --- |
| [getCatalogs](/docs/en/analytics-datacatalog-catalog-getcatalogs) | Get catalog |

### Database

The following describes the database-related APIs.

| API | Description |
| --- | --- |
| [getDatabase](/docs/en/analytics-datacatalog-database-getdatabase) | Get database details |
| [getDatabases](/docs/en/analytics-datacatalog-database-getdatabases) | Get database list |

### Table

The following describes the table-related APIs.

| API | Description |
| --- | --- |
| [getTable](/docs/en/analytics-datacatalog-table-gettable) | Get table details. |
| [getTablePartitions](/docs/en/analytics-datacatalog-table-gettablepartitions) | Get table partition list. |
| [getTablePartitionKeys](/docs/en/analytics-datacatalog-table-gettablepartitionkeys) | Get table partition key list. |
| [getTableProperties](/docs/en/analytics-datacatalog-table-gettableproperties) | Get table property details. |
| [getTableSchema](/docs/en/analytics-datacatalog-table-gettableschema) | Get table schema list. |
| [getTableSchemaAndPartitionKeys](/docs/en/analytics-datacatalog-table-gettableschemaandpartitionkeys) | Get table schema and partition key list. |
| [getTableSchemaByVersion](/docs/en/analytics-datacatalog-table-gettableschemabyversion) | Get schema version details. |
| [getTableSchemaVersions](/docs/en/analytics-datacatalog-table-gettableschemaversions) | Get table schema version list. |
| [getTableTags](/docs/en/analytics-datacatalog-table-gettabletags) | Get table tag list. |
| [getTables](/docs/en/analytics-datacatalog-table-gettables) | Get table list in catalog. |
| [getTablesByDatabase](/docs/en/analytics-datacatalog-table-gettablesbydatabase) | Get table list in database. |

### Scanner

The following describes the scanner-related APIs.

| API | Description |
| --- | --- |
| [getScanner](/docs/en/analytics-datacatalog-scanner-getscanner) | Get scanner details. |
| [getScannerHistories](/docs/en/analytics-datacatalog-scanner-getscannerhistories) | Get scanner execution history. |
| [getScanners](/docs/en/analytics-datacatalog-scanner-getscanners) | Get scanner list. |
| [runScanner](/docs/en/analytics-datacatalog-scanner-runscanner) | Run scanner. |
| [stopScanner](/docs/en/analytics-datacatalog-scanner-stopscanner) | Stop scanner execution. |

### Connection

The following describes the connection-related APIs.

| API | Description |
| --- | --- |
| [getConnection](/docs/en/analytics-datacatalog-connection-getconnection) | Get connection details. |
| [getConnections](/docs/en/analytics-datacatalog-connection-getconnections) | Get connection list. |

## Data Catalog related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand Data Catalog APIs.

- Data Catalog API guides
  - [Create signature](/docs/en/common-ncpapi): how to create a signature to add to the request header
  - [API Gateway User Guide](https://guide.ncloud-docs.com/docs/en/apigw-apigw-1): how to issue the API key to be added to the request header
  - [Sub Account User Guide](https://guide.ncloud-docs.com/docs/en/subaccount-overview): how to issue the access key to be added to the request header
  - [Common Ncloud response status codes](/docs/en/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C): information on common response status codes of NAVER Cloud Platform used by the Data Catalog service
- Data Catalog service guides
  - [Data Catalog User Guide](https://guide.ncloud-docs.com/docs/en/datacatalog-overview): how to use Data Catalog in the NAVER Cloud Platform console
  - [Ncloud use environment guide](https://guide.ncloud-docs.com/docs/en/environment-environment-1-1): guide for VPC and Classic environments and support availability
  - [Introduction to pricing, characteristics, and detailed features](https://www.ncloud.com/product/analytics/dataCatalog): summary of Data Catalog pricing system, characteristics, and detailed features
  - [Latest service news](https://www.ncloud.com/intro/news): the latest news related to Data Catalog
  - [FAQ](https://www.ncloud.com/support/faq/prod?categoryCode2=ANALY&categoryCode3=SV_0226&page=1): frequently asked questions from the Data Catalog service users
  - [Contact us](https://www.ncloud.com/support/question/general): Send direct inquiries for unresolved questions that aren't answered by the API guide.