MENU
      getDatabase

        getDatabase


        記事の要約

        VPC環境で利用できます。

        ユーザー catalogの database名で特定の databaseを照会します。

        リクエスト

        リクエスト URL

        GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/databases/{database-name}
        HTTP

        リクエストパラメータ

        パラメータ名要否タイプ制約事項説明
        catalogIdYesStringcatalogの固有 id
        (ref: getCatalogs)
        databaseNameYesStringdatabase名
        includeTagsYesBooleanレスポンス値内の tag情報有無

        リクエストヘッダ

        共通ガイド参照

        リクエスト例

        curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/databases/{database-name}?includeTags=true" \
            -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}" \
            -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"  \
            -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
        Bash

        レスポンス

        レスポンスボディ

        項目タイプ説明
        catalogIdIntcatalogの固有 id
        nameStringdatabase名
        databaseNameStringdatabase名
        descriptionStringdatabaseの説明
        locationStringdatabaseの位置
        tagKeyTypeValueList[].tagKeyStringtagの key
        tagKeyTypeValueList[].tagTypeStringtagの type
        tagKeyTypeValueList[].tagValueStringtagの value
        tagKeyTypeValueList[].tagTemplateTagIdInttagの固有 id
        createTimeDatedatabaseの作成日時
        updateTimeDatedatabaseの修正日時

        レスポンス例

        HTTP

        HTTP StatusDescription
        200OK

        JSON

        {
          "catalogId": 2144,
          "name": "default",
          "databaseName": "default",
          "description": "Default Data Catalog database1",
          "location": "s3a://datacatalog-c2144-a0211690/default",
          "tagKeyTypeValueList": [
            {
              "tagKey": "key",
              "tagType": "STRING",
              "tagValue": "value",
              "tagTemplateTagId": 0
            }
          ],
          "createTime": "2023-02-21T15:35:09+0900",
          "updateTime": "2023-02-21T16:22:00+0900"
        }
        JSON

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

        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.