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-timestamp1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの
    API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
    x-ncp-iam-access-keyNAVER 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ステータスエラーコードメッセージ説明解決策
    40011006Running Metastore is not found動作中の metastoreなしカスタマーサポート > お問い合わせで問い合わせる
    40014443現在のスキャナーのステータスでは許可されていないタスクです。当該スキャナーのステータスで許可しない動作をリクエストすると発生スキャナーステータスを確認後に呼び出し
    40414440スキャナーが見つかりません。照会する scanner情報がない場合呼び出し値の再確認

    この記事は役に立ちましたか?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.