VPC環境で利用できます。
データベースを作成します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /api/v1/catalogs/{catalogId}/databases |
リクエストヘッダ
Data Catalog APIで共通して使用されるヘッダの詳細は、Data Catalogのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
catalogId |
Integer | Required | カタログ ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
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 | - | カタログ ID |
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 | - | タグテンプレートタグ ID
|
レスポンスステータスコード
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"
}