---
title: "Data Catalogの概要"
slug: "analytics-datacatalog"
updated: 2026-09-17T09:57:35Z
published: 2026-09-17T09:57:35Z
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は、データ資産の活用性を強化する NAVERクラウドプラットフォームのメタデータ統合・管理サービスです。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 | NAVERクラウドプラットフォームから発行された Access Key - Access Keyの発行と確認: [認証キーの作成](/docs/ja/common-ncpapi)を参照 - サブアカウントの Access Key発行と確認: [サブアカウントの作成](https://guide.ncloud-docs.com/docs/ja/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 | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名 - Secret Keyの発行と確認: [認証キーの作成](/docs/ja/common-ncpapi)を参照 - 署名の作成: [シグネチャーの作成](/docs/ja/common-ncpapi)を参照 |

### レスポンス

共通レスポンス形式を説明します。

#### レスポンスボディ

レスポンスボディの説明は次の通りです。

**responseError**

responseErrorは API呼び出し失敗情報を定義します。responseErrorの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `error` | Object | - | エラーコードとメッセージ |
| `errorCode` | Integer | - | エラーコード |
| `message` | String | - | エラーメッセージ |

#### レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

| HTTPステータスコード | コード | メッセージ | 説明 | 解決方法 |
| --- | --- | --- | --- | --- |
| 400 | 11006 | Running Metastore is not found | 動作中のメタストアはない | NAVERクラウドプラットフォームポータルの[お問い合わせ](https://www.ncloud.com/support/question/service)から問い合わせる |
| 400 | 14443 | 現在のスキャナー状態では許可されていない操作です。 | リクエストした動作がそのスキャナー状態では許可されていない | スキャナーの状態を確認してから呼び出す |
| 404 | 14440 | スキャナーが見つかりません。 | 照会しようとするスキャナーがない | 呼び出し値を再度確認 |

参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、[Ncloud APIのレスポンスステータスコード](/docs/ja/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/ja/analytics-datacatalog-catalog-getcatalogs) | カタログを照会 |

### Database

Database関連 APIの説明は次の通りです。

| API | 説明 |
| --- | --- |
| [getDatabase](/docs/ja/analytics-datacatalog-database-getdatabase) | データベースの詳細情報を照会 |
| [getDatabases](/docs/ja/analytics-datacatalog-database-getdatabases) | データベースリストを照会 |

### Table

Table関連 APIの説明は次の通りです。

| API | 説明 |
| --- | --- |
| [getTable](/docs/ja/analytics-datacatalog-table-gettable) | テーブルの詳細情報を照会 |
| [getTablePartitions](/docs/ja/analytics-datacatalog-table-gettablepartitions) | テーブルパーティションリストを照会 |
| [getTablePartitionKeys](/docs/ja/analytics-datacatalog-table-gettablepartitionkeys) | テーブルパーティションキーリストを照会 |
| [getTableProperties](/docs/ja/analytics-datacatalog-table-gettableproperties) | テーブルの詳細属性情報を照会 |
| [getTableSchema](/docs/ja/analytics-datacatalog-table-gettableschema) | テーブルスキーマリストを照会 |
| [getTableSchemaAndPartitionKeys](/docs/ja/analytics-datacatalog-table-gettableschemaandpartitionkeys) | テーブルスキーマとパーティションキーリストを照会 |
| [getTableSchemaByVersion](/docs/ja/analytics-datacatalog-table-gettableschemabyversion) | テーブルスキーマバージョンの詳細情報を照会 |
| [getTableSchemaVersions](/docs/ja/analytics-datacatalog-table-gettableschemaversions) | テーブルスキーマバージョンリストを照会 |
| [getTableTags](/docs/ja/analytics-datacatalog-table-gettabletags) | テーブルタグリストを照会 |
| [getTables](/docs/ja/analytics-datacatalog-table-gettables) | カタログのテーブルリストを照会 |
| [getTablesByDatabase](/docs/ja/analytics-datacatalog-table-gettablesbydatabase) | データベースのテーブルリストを照会 |

### Scanner

Scanner関連 APIの説明は次の通りです。

| API | 説明 |
| --- | --- |
| [getScanner](/docs/ja/analytics-datacatalog-scanner-getscanner) | スキャナーの詳細情報を照会 |
| [getScannerHistories](/docs/ja/analytics-datacatalog-scanner-getscannerhistories) | スキャナーの実行履歴を照会 |
| [getScanners](/docs/ja/analytics-datacatalog-scanner-getscanners) | スキャナーリストを照会 |
| [runScanner](/docs/ja/analytics-datacatalog-scanner-runscanner) | スキャナーを実行 |
| [stopScanner](/docs/ja/analytics-datacatalog-scanner-stopscanner) | スキャナーの実行を停止 |

### Connection

Connection関連 APIの説明は次の通りです。

| API | 説明 |
| --- | --- |
| [getConnection](/docs/ja/analytics-datacatalog-connection-getconnection) | コネクションの詳細情報を照会 |
| [getConnections](/docs/ja/analytics-datacatalog-connection-getconnections) | コネクションリストを照会 |

## Data Catalog関連リソース

Data Catalog APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。

- Data Catalog APIの使用方法
  - [署名(シグネチャー)の作成](/docs/ja/common-ncpapi): リクエストヘッダに追加する署名の作成方法
  - [API Gatewayご利用ガイド](https://guide.ncloud-docs.com/docs/ja/apigw-apigw-1): リクエストヘッダに追加する API Keyを発行
  - [Sub Accountご利用ガイド](https://guide.ncloud-docs.com/docs/ja/subaccount-overview): リクエストヘッダに追加する Access Keyの発行方法
  - [Ncloudの共通レスポンスステータスコード](/docs/ja/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C): Data Catalogサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
- Data Catalogサービスの使用方法
  - [Data Catalogご利用ガイド](https://guide.ncloud-docs.com/docs/ja/datacatalog-overview): NAVERクラウドプラットフォームコンソールで Data Catalogを使用する方法
  - [Ncloud使用環境ガイド](https://guide.ncloud-docs.com/docs/ja/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ガイドだけでは不明な点が解消されない場合、直接問い合わせ