---
title: "getDatabase"
slug: "analytics-datacatalog-database-getdatabase"
updated: 2026-09-17T09:16:09Z
published: 2026-09-17T09:16:09Z
canonical: "api.ncloud-docs.com/analytics-datacatalog-database-getdatabase"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# getDatabase

VPC 환경에서 이용 가능합니다.

데이터베이스의 상세 정보를 조회합니다.

## 요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

| 메서드 | URI |
| --- | --- |
| GET | /api/v1/catalogs/{catalogId}/databases/{databaseName} |

### 요청 헤더

Data Catalog API에서 공통으로 사용하는 헤더에 대한 정보는 [Data Catalog 요청 헤더](/docs/analytics-datacatalog#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오.

### 요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `catalogId` | Integer | Required | 카탈로그 아이디 - [getCatalogs](/docs/analytics-datacatalog-catalog-getcatalogs) 참조 |
| `databaseName` | String | Required | 데이터베이스 이름 - [getDatabases](/docs/analytics-datacatalog-database-getdatabases) 참조 |

### 요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `includeTags` | Boolean | Required | 응답 내 태그 포함 여부 - `true` \| `false` - `true`: 포함 - `false`: 포함 안 함 |

### 요청 예시

요청 예시는 다음과 같습니다.

```
curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/my_database?includeTags=true' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## 응답

응답 형식을 설명합니다.

### 응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `catalogId` | Integer | - | 카탈로그 아이디 |
| `name` | String | - | 데이터베이스 이름 |
| `databaseName` | String | - | 데이터베이스 이름 |
| `description` | String | - | 데이터베이스 설명 |
| `location` | String | - | 데이터베이스 위치 |
| `tagKeyTypeValueList` | Array | - | 태그 목록: [tagKeyTypeValueList](/docs/analytics-datacatalog-database-getdatabase#tagKeyTypeValueList) - 요청에서 `includeTags`가 `true`인 경우, 표시 |
| `createTime` | String | - | 데이터베이스 생성 일시 - ISO 8601 형식 |
| `updateTime` | String | - | 데이터베이스 업데이트 일시 - ISO 8601 형식 |

#### `tagKeyTypeValueList`

`tagKeyTypeValueList`에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `tagKey` | String | - | 태그 키 |
| `tagType` | String | - | 태그 유형 |
| `tagValue` | String | - | 태그 값 |
| `tagTemplateTagId` | Integer | - | 태그 아이디 - 태그 템플릿에 저장된 태그 고유 번호 - 태그 템플릿에 저장되지 않은 경우: `0` |

### 응답 상태 코드

Data Catalog API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Data Catalog 응답 상태 코드](/docs/analytics-datacatalog#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오.

### 응답 예시

응답 예시는 다음과 같습니다.

```
{
    "catalogId": 4**,
    "name": "my_database",
    "databaseName": "my_database",
    "description": "my database",
    "location": "s3a://datacatalog-c***-e******f/my_database",
    "tagKeyTypeValueList": [
        {
            "tagKey": "name",
            "tagType": "STRING",
            "tagValue": "name",
            "tagTemplateTagId": 464
        }
    ],
    "createTime": "2025-03-17T16:30:08+0900",
    "updateTime": "2025-03-17T16:57:43+0900"
}
```