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.

createDatabase

Prev Next

VPC環境で利用できます。

データベースを作成します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/catalogs/{catalogId}/databases

リクエストヘッダ

Data Catalog APIで共通して使用されるヘッダの詳細は、Data Catalogのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
catalogId Integer Required カタログ ID

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
name String Required データベースの名前
  • 1~128文字
  • 小文字、数字、_-、スペースのみ使用可能 ([a-z0-9_\-\s]+$)
location String Required データベースの位置(パス)
  • 最大1,000文字
  • 入力したパスの後ろにnameをサブパスとして追加
  • 例) s3a://mybucket + mydatabases3a://mybucket/mydatabase)
description String Optional データベースの説明
  • 最大1,000文字
tagKeyTypeValueList Array Optional タグリスト: tagKeyTypeValueList

tagKeyTypeValueList

tagKeyTypeValueListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
tagKey String Required タグのキー
  • 1~64文字
tagType String Required タグのタイプ
  • STRING | DOUBLE | BOOLEAN | DATETIME
tagValue String Required タグの値
  • 1~256文字

リクエスト例

リクエストのサンプルコードは次の通りです。

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 - データベースの作成日時
  • ISO 8601形式
updateTime String - データベースの更新日時
  • ISO 8601形式

tagKeyTypeValueList

tagKeyTypeValueListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
tagKey String - タグキー
tagType String - タグのタイプ
  • STRING | DOUBLE | BOOLEAN | DATETIME
tagValue String - タグの値
tagTemplateTagId Integer - タグテンプレートタグ ID
  • タグテンプレートが連携されていない場合、0

レスポンスステータスコード

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"
}