Data Catalogの概要

Prev Next

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分以上の場合は無効なリクエストとみなす
x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された 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 動作中のメタストアはない NAVERクラウドプラットフォームポータルのお問い合わせから問い合わせる
400 14443 現在のスキャナー状態では許可されていない操作です。 リクエストした動作がそのスキャナー状態では許可されていない スキャナーの状態を確認してから呼び出す
404 14440 スキャナーが見つかりません。 照会しようとするスキャナーがない 呼び出し値を再度確認
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、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についてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。