MENU
      getDatabase

        getDatabase


        Article summary

        Available in VPC

        Searches for a specific database with the database name of the user's catalog.

        Requests

        Request URL

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

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        catalogIdYesStringUnique catalog ID
        (ref: getCatalogs)
        databaseNameYesStringDatabase name
        includeTagsYesBooleanInclusion status of the tag information in the response value

        Request header

        See common guide.

        Request examples

        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

        Responses

        Response bodies

        ItemTypeDescription
        catalogIdIntUnique catalog ID
        nameStringDatabase name
        databaseNameStringDatabase name
        descriptionStringDatabase description
        locationStringDatabase location
        tagKeyTypeValueList[].tagKeyStringKey of the tag
        tagKeyTypeValueList[].tagTypeStringType of the tag
        tagKeyTypeValueList[].tagValueStringValue of the tag
        tagKeyTypeValueList[].tagTemplateTagIdIntUnique tag ID
        createTimeDateDatabase creation date and time
        updateTimeDateDatabase modification date and time

        Response examples

        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

        Was this article helpful?

        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.