getTableTags

VPC環境で利用できます。

テーブルのタグリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSize`	Integer	Optional	ページの出力数 1~200 (デフォルト: 20)

リクエスト例

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

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/log_database/tables/log_table_1/tags?pageNo=1&pageSize=20' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	-	ページ番号
`pageSize`	Integer	-	ページ表示数
`totalCount`	Integer	-	レスポンス結果数
`tagKeyTypeValueList`	Array	-	タグリスト
`catalogId`	Integer	-	カタログ ID
`tableName`	String	-	テーブル名
`databaseName`	String	-	データベースの名前

`tagKeyTypeValueList`

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

フィールド	タイプ	必須の有無	説明
`tagKey`	String	-	タグキー
`tagType`	String	-	タグのデータ形式
`tagValue`	String	-	タグの値
`tagTemplateTagId`	Integer	-	タグ ID タグテンプレートに保存されたタグの固有番号タグテンプレートに保存されていない場合: `0`

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

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

レスポンス例

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

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 4,
    "tagKeyTypeValueList": [
        {
            "tagKey": "data source",
            "tagType": "STRING",
            "tagValue": "server01",
            "tagTemplateTagId": 468
        },
        {
            "tagKey": "num_rows",
            "tagType": "DOUBLE",
            "tagValue": "3600",
            "tagTemplateTagId": 469
        },
        {
            "tagKey": "ifchecked",
            "tagType": "BOOLEAN",
            "tagValue": "true",
            "tagTemplateTagId": 470
        },
        {
            "tagKey": "event_starttime",
            "tagType": "DATETIME",
            "tagValue": "2025-03-18 10:00:00",
            "tagTemplateTagId": 0
        }
    ],
    "catalogId": 4**,
    "tableName": "log_table_1",
    "databaseName": "log_database"
}