Data Catalogの概要
- 印刷する
- PDF
Data Catalogの概要
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
概要
Data Catalogご利用の申し込みをすると、カタログと基本提供データベースが自動で作成されます。データベースはテーブルの集合として、メタデータを保存します。Databaseメニューでは、カタログの状態を確認し、データベースを作成して管理できます。
共通設定
API URL
https://datacatalog.apigw.ntruss.com/api/v1/
リクエストヘッダ
ヘッダ名 | 説明 |
---|---|
Content-Type | リクエスト Body Content Typeを application/jsonに指定(POST) |
x-ncp-apigw-timestamp | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす |
x-ncp-iam-access-key | NAVER Cloud Platformで発行された API Keyまたは IAMで発行された AccessKey |
x-ncp-apigw-signature-v2 | 上記ユースケースの Bodyを AccessKeyとマッピングする SecretKeyで暗号化した署名 HMAC暗号化アルゴリズムは HmacSHA256を使用 |
参考
詳細は、NAVER Cloud Platform APIガイドをご参照ください。
オペレーション
Catalog
API名 | 説明 |
---|---|
getCatalogs | ユーザーのすべての catalog idを照会 |
Connection
API名 | 説明 |
---|---|
getConnections | ユーザー catalogのすべての connectionを照会 |
getConnection | ユーザー catalogの特定の connection idに該当する connectionを照会 |
Scanner
API名 | 説明 |
---|---|
getScanners | ユーザー catalogのすべての scannerを照会 |
getScanner | ユーザー catalogの特定の scanner idに該当する scannerを照会 |
getScannerHistories | ユーザー catalogの特定の scannerの実行履歴を確認 |
runScanner | ユーザー catalogの特定の scannerを実行 |
stopScanner | ユーザー catalogの実行中の scannerを停止 |
Database
API名 | 説明 |
---|---|
getDatabases | ユーザー catalogが持つすべての databaseを照会 |
getDatabase | ユーザー catalogの database名で特定の databaseを照会 |
Table
API名 | 説明 |
---|---|
getTables | ユーザー catalogのすべての tableを照会 |
getTable | ユーザー catalogの database/table名で特定の tableを照会 |
getTablesByDatabase | ユーザー catalogの database名で特定の databaseのすべての tableを照会 |
getTablePartitions | ユーザー catalogの database/table名で特定の tableの partition key/valueを照会 |
getTableTags | ユーザー catalogの database/table名で特定の tableのすべてのタグを照会 |
getTableSchema | ユーザー catalogの database/table名で特定の tableの schemaを照会 |
getTableSchemaVersions | ユーザー catalogの database/table名で特定の tableの schema versionを照会 |
getTableSchemaByVersion | ユーザー catalogの database/table名、schema versionで table schemaを照会 |
getTableSchemaAndPartitionKeys | ユーザー catalogの database/table名で特定の tableの schema/partition keyを照会 |
エラーレスポンスの形式
APIリクエストが間違っていたり、処理中にエラーが発生した場合、HTTPステータスコードで成功/失敗を返し、JSON形式で詳細メッセージを返します。
レスポンス例
{
"error": {
"errorCode": "integer",
"message": "string"
}
}
エラーレスポンス
HTTPステータス | エラーコード | メッセージ | 説明 | 解決策 |
---|---|---|---|---|
400 | 11006 | Running Metastore is not found | 動作中の metastoreなし | カスタマーサポート > お問い合わせで問い合わせる |
400 | 14443 | 現在のスキャナーのステータスでは許可されていないタスクです。 | 当該スキャナーのステータスで許可しない動作をリクエストすると発生 | スキャナーステータスを確認後に呼び出し |
404 | 14440 | スキャナーが見つかりません。 | 照会する scanner情報がない場合 | 呼び出し値の再確認 |
この記事は役に立ちましたか?