getTable

VPC環境で利用できます。

テーブルの詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/my_database/tables/employeelist' \
--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	-	レスポンス結果数
`requestId`	String	-	リクエスト ID UUID形式
`tableResponseList`	Array	-	テーブル情報

`tableResponseList`

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

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	-	カタログ ID
`databaseName`	String	-	データベースの名前
`tableName`	String	-	テーブル名
`dataFormat`	String	-	データ形式
`location`	String	-	テーブルの位置
`description`	String	-	テーブルの説明
`createTime`	String	-	テーブルの作成日時 ISO 8601形式
`updateTime`	String	-	更新日時 ISO 8601形式
`properties`	Object	-	テーブルの属性情報 NAVERクラウドプラットフォームコンソールに表示されるテーブルの詳細属性情報と同じ
`properties.EXTERNAL`	String	-	テーブルを外部に保存するかどうか `TRUE` \| `FALSE` `TRUE`: 外部に保存 `FALSE`: 内部に保存
`properties.compressionType`	String	-	圧縮ファイルの拡張子スキャン対象が圧縮ファイルの場合、表示
`properties.clusterNo`	String	-	DBサービス番号スキャン対象がデータベースの場合、表示
`properties.connectionId`	String	-	コネクション ID コネクションが存在する場合、表示
`properties.connectionName`	String	-	コネクション名コネクションが存在する場合、表示
`properties.created_time`	String	-	テーブルの作成日時 Unix Timestamp形式
`properties.dataFormat`	String	-	データ形式
`properties.dataType`	String	-	データタイプ
`properties.delimiter`	String	-	区切り文字データが CSVファイルの場合、表示
`properties.inputFormat`	String	-	データ読み取り形式
`properties.isDirectory`	String	-	スキャン対象はディレクトリかどうか `TRUE` \| `FALSE` `TRUE`: ディレクトリ `FALSE`: ディレクトリではない
`properties.last_modified_time`	String	-	更新日時 Unix Timestamp形式
`properties.metadata_location`	String	-	メタデータのファイルパス Icebergテーブルの場合、表示
`properties.numFiles`	String	-	スキャンした総ファイル数スキャン対象がディレクトリの場合、表示
`properties.objectstorageContentLength`	String	-	オブジェクトの長さ(Byte)
`properties.objectstorageContentType`	String	-	オブジェクトのデータタイプ
`properties.objectstorageLastModified`	String	-	オブジェクトの更新日時 Unix Timestamp形式
`properties.outputFormat`	String	-	データ出力形式
`properties.partitioningScheme`	String	-	パーティショニングスキーマスキャン対象にパーティションが認識された場合、表示
`properties.scannerId`	String	-	スキャナー ID
`properties.scannerName`	String	-	スキャナー名
`properties.serializationLib`	String	-	シリアル化・逆シリアル化ライブラリ
`properties.skip.header.line.count`	String	-	除外したヘッダライン数
`properties.totalSize`	String	-	スキャンした総データ量(Byte) スキャン対象がディレクトリの場合、表示
`properties.transient_lastDdlTime`	String	-	テーブル DDLの更新日時 Unix Timestamp形式
`properties.serde.escapeChar`	String	-	データ認識除去文字データが CSVファイルの場合、表示
`properties.serde.quoteChar`	String	-	データ認識文字データが CSVファイルの場合、表示
`properties.serde.separatorChar`	String	-	スキーマ決定区切り文字データが CSVファイルの場合、表示

参考

テーブルタイプに応じて表示される属性情報が異なる場合があります。

Apache Icebergテーブルの属性情報の詳細は、Iceberg Table Metadataをご参照ください。

RDBデータの場合

RDB(MySQL、MSSQL、PostgreSQL)データの場合、追加で表示される属性の説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`properties.{dbType}Collation`	String	-	文字列ソート設定
`properties.{dbType}DataSize`	String	-	データのサイズ
`properties.{dbType}IndexSize`	String	-	インデックスのサイズ
`properties.{dbType}Indexes`	String	-	インデックスの構造
`properties.{dbType}Rows`	String	-	行(レコード)数
`properties.{dbType}TableSize`	String	-	テーブルの総サイズ

MongoDBデータの場合

MongoDBデータの場合、追加で表示される属性の説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`properties.mongodbAvgObjSize`	String	-	コレクションのオブジェクトサイズの平均
`properties.mongodbFreeStorageSize`	String	-	コレクションの空き容量
`properties.mongodbIndexSize`	String	-	コレクションインデックスのサイズ
`properties.mongodbIndexes`	String	-	コレクションインデックス情報
`properties.mongodbRowCount`	String	-	コレクション行(レコード)数
`properties.mongodbSize`	String	-	コレクションサイズ圧縮されていないサイズインデックスサイズを除く
`properties.mongodbStorageSize`	String	-	コレクションに割り当てられたストレージ容量
`properties.mongodbTotalSize`	String	-	コレクションの総ディスク容量

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

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

レスポンス例

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

{
    "catalogId": 4**,
    "databaseName": "default",
    "tableName": "employeelist",
    "dataFormat": "csv",
    "location": "s3a://datacatalog-c***-e******f/my_database/employeeList/",
    "createTime": "2025-03-18T09:34:52+0900",
    "updateTime": "2025-03-18T09:42:28+0900",
    "properties": {
        "EXTERNAL": "TRUE",
        "compressionType": "",
        "created_time": "1742258092",
        "dataFormat": "csv",
        "dataType": "file",
        "inputFormat": "org.apache.hadoop.mapred.TextInputFormat",
        "isDirectory": "TRUE",
        "last_modified_time": "1742258548",
        "numFiles": "1",
        "objectstorageContentLength": "5095",
        "objectstorageContentType": "text/csv",
        "objectstorageLastModified": "1742257929",
        "outputFormat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
        "scannerId": "9**",
        "scannerName": "employee_list",
        "serializationLib": "org.apache.hadoop.hive.serde2.OpenCSVSerde",
        "skip.header.line.count": "1",
        "totalSize": "5095",
        "transient_lastDdlTime": "1742258092",
        "serde.escapeChar": "\\",
        "serde.quoteChar": "\"",
        "serde.separatorChar": ","
    }
}