updateDatabaseTag

VPC環境で利用できます。

データベースのタグを変更します。リクエストボディで送信されたタグリストにより、既存のタグがすべて置き換えられます。

リクエスト

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

メソッド	URI
PUT	/api/v1/catalogs/{catalogId}/databases/{databaseName}/tag

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	Required	カタログ ID getCatalogsを参照
`databaseName`	String	Required	データベース名 getDatabaseを参照

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`tagKeyTypeValueList`	Array	Required	タグリスト: tagKeyTypeValueList 送信したリストでタグをすべて置換空の配列(`[]`)を渡すとすべてのタブを削除

`tagKeyTypeValueList`

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

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

リクエスト例

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

curl --location --request PUT 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/mydatabase/tag' \
--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 '{
    "tagKeyTypeValueList": [
        {
            "tagKey": "owner",
            "tagType": "STRING",
            "tagValue": "data-team"
        },
        {
            "tagKey": "pii",
            "tagType": "BOOLEAN",
            "tagValue": "true"
        }
    ]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	-	カタログ ID
`name`	String	-	データベースの名前
`databaseName`	String	-	データベースの名前
`description`	String	-	データベースの説明値が存在する場合、表示
`location`	String	-	データベースの位置(パス)
`createTime`	String	-	データベースの作成日時 ISO 8601形式
`updateTime`	String	-	データベースの更新日時 ISO 8601形式

タグ変更結果のレスポンスには、タグリスト(tagKeyTypeValueList)は含まれません。変更されたタグを確認するには、getDatabase(includeTags=true)をご利用ください。

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

Data Catalog APIで共通して使用されるレスポンスステータスコードの詳細は、Data Catalogのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "catalogId": 4**,
    "name": "mydatabase",
    "databaseName": "mydatabase",
    "description": "my database description",
    "location": "s3a://mybucket/mydatabase",
    "createTime": "2026-06-25T14:44:55+0900",
    "updateTime": "2026-06-25T15:22:00+0900"
}

Documentation Index