MENU
      getDatabases

        getDatabases


        Article summary

        Available in VPC

        Searches for all databases in the user’s catalog.

        Requests

        Request URL

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

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        catalogIdYesStringUnique catalog ID
        (ref: getCatalogs)
        pageNoNointPage number
        Default: 1
        pageSizeNointMaximum: 200Size of result list
        Default: 20
        searchValueNoStringSearch word for the name of the database

        Request header

        See common guide.

        Request examples

        curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/databases?pageNo=1&pageSize=20" \
            -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

        • databaseResponseList: database list of the user’s catalog
        ItemTypeDescription
        catalogIdIntUnique catalog ID
        nameStringDatabase name
        descriptionStringDatabase description
        createTimeDateDatabase creation date and time

        Response examples

        HTTP

        HTTP StatusDescription
        200OK

        JSON

        {
          "pageNo": 1,
          "pageSize": 20,
          "totalCount": 1,
          "requestId": "7cf2c366-986e-461a-afae-4cc081c153dd",
          "databaseResponseList": [
            {
              "catalogId": 2144,
              "name": "default",
              "description": "Default Data Catalog database1",
              "createTime": "2023-02-21T15:35:30+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.