updateTableTag

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエストボディ

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

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

`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/tables/mytable/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"
        }
    ]
}'

レスポンス

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

レスポンスボディ

成功すると本文なしで204 No Contentを返します。

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

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

HTTP Status	説明
204	No Content (変更成功)

Documentation Index