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.