VPC 환경에서 이용 가능합니다.
데이터베이스를 생성합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| POST | /api/v1/catalogs/{catalogId}/databases |
요청 헤더
Data Catalog API에서 공통으로 사용하는 헤더에 대한 정보는 Data Catalog 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
catalogId |
Integer | Required | 카탈로그 아이디
|
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
name |
String | Required | 데이터베이스 이름
|
location |
String | Required | 데이터베이스 위치(경로)
|
description |
String | Optional | 데이터베이스 설명
|
tagKeyTypeValueList |
Array | Optional | 태그 목록: tagKeyTypeValueList |
tagKeyTypeValueList
tagKeyTypeValueList에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
tagKey |
String | Required | 태그 키
|
tagType |
String | Required | 태그 타입
|
tagValue |
String | Required | 태그 값
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"name": "mydatabase",
"location": "s3a://mybucket",
"description": "my database description",
"tagKeyTypeValueList": [
{
"tagKey": "owner",
"tagType": "STRING",
"tagValue": "data-team"
}
]
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
catalogId |
Integer | - | 카탈로그 아이디 |
name |
String | - | 데이터베이스 이름 |
databaseName |
String | - | 데이터베이스 이름 |
description |
String | - | 데이터베이스 설명
|
location |
String | - | 데이터베이스 위치(경로) |
tagTemplateName |
String | - | 태그 템플릿 이름
|
tagKeyTypeValueList |
Array | - | 태그 목록: tagKeyTypeValueList
|
createTime |
String | - | 데이터베이스 생성 일시
|
updateTime |
String | - | 데이터베이스 수정 일시
|
tagKeyTypeValueList
tagKeyTypeValueList에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
tagKey |
String | - | 태그 키 |
tagType |
String | - | 태그 타입
|
tagValue |
String | - | 태그 값 |
tagTemplateTagId |
Integer | - | 태그 템플릿 태그 아이디
|
응답 상태 코드
Data Catalog API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Data Catalog 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"catalogId": 4**,
"name": "mydatabase",
"databaseName": "mydatabase",
"description": "my database description",
"location": "s3a://mybucket/mydatabase",
"tagKeyTypeValueList": [
{
"tagKey": "owner",
"tagType": "STRING",
"tagValue": "data-team",
"tagTemplateTagId": 0
}
],
"createTime": "2026-06-25T14:44:55+0900",
"updateTime": "2026-06-25T14:44:55+0900"
}