--- title: "getTableProperties" slug: "analytics-datacatalog-table-gettableproperties" updated: 2026-09-17T09:57:35Z published: 2026-09-17T09:57:35Z canonical: "api.ncloud-docs.com/analytics-datacatalog-table-gettableproperties" --- > ## 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. # getTableProperties VPC環境で利用できます。 テーブルの詳細属性情報を照会します。 ## リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | GET | /api/v1/catalogs/{catalogId}/databases/{databaseName}/tables/{tableName}/properties | ### リクエストヘッダ Data Catalog APIで共通して使用されるヘッダの詳細は、[Data Catalogのリクエストヘッダ](/docs/ja/analytics-datacatalog#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストパスパラメータ リクエストパスパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `catalogId` | Integer | Required | カタログ ID - [getCatalogs](/docs/ja/analytics-datacatalog-catalog-getcatalogs)を参照 | | `databaseName` | String | Required | データベース名 - [getDatabases](/docs/ja/analytics-datacatalog-database-getdatabases)を参照 | | `tableName` | String | Required | テーブル名 - [getTables](/docs/ja/analytics-datacatalog-table-gettables)を参照 | ### リクエスト例 リクエストのサンプルコードは次の通りです。 ``` curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/default/tables/atmosphere_data/properties' \ --header 'x-ncp-apigw-timestamp: {Timestamp}' \ --header 'x-ncp-iam-access-key: {Access Key}' \ --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' ``` ## レスポンス レスポンス形式を説明します。 ### レスポンスボディ レスポンスボディの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `storageFormatInfo` | Object | - | ストレージ形式情報 | | `storageFormatInfo.inputFormat` | String | - | データ読み取り形式 | | `storageFormatInfo.outputFormat` | String | - | データ出力形式 | | `storageFormatInfo.serializationLib` | String | - | シリアル化・逆シリアル化ライブラリ | | `serdeParams` | Object | - | SerDeパラメータ | | `serdeParams.quoteChar` | String | - | データ認識文字 - データが CSVファイルの場合、表示 | | `serdeParams.escapeChar` | String | - | データ認識除去文字 - データが CSVファイルの場合、表示 | | `serdeParams.separatorChar` | String | - | スキーマ決定区切り文字 - データが CSVファイルの場合、表示 | | `tableParams` | Object | - | テーブルパラメータ | | `tableParams.EXTERNAL` | String | - | テーブルを外部に保存するか - `TRUE` \| `FALSE` - `TRUE`: 外部に保存 - `FALSE`: 内部に保存 | | `tableParams.compressionType` | String | - | 圧縮ファイルの拡張子 - スキャン対象が圧縮ファイルの場合、表示 | | `tableParams.clusterNo` | String | - | DBサービス番号 - スキャン対象がデータベースの場合、表示 | | `tableParams.connectionId` | String | - | コネクション ID - コネクションが存在する場合、表示 | | `tableParams.connectionName` | String | - | コネクション名 - コネクションが存在する場合、表示 | | `tableParams.created_time` | String | - | テーブルの作成日時 - Unix Timestamp形式 | | `tableParams.dataFormat` | String | - | データ形式 | | `tableParams.dataType` | String | - | データタイプ | | `tableParams.delimiter` | String | - | 区切り文字 - データが CSVファイルの場合、表示 | | `tableParams.isDirectory` | String | - | スキャン対象はディレクトリかどうか - `TRUE` \| `FALSE` - `TRUE`: ディレクトリ - `FALSE`: ディレクトリではない | | `tableParams.last_modified_time` | String | - | 更新日時 - Unix Timestamp形式 | | `tableParams.metadata_location` | String | - | メタデータのファイルパス - Icebergテーブルの場合、表示 | | `tableParams.numFiles` | String | - | スキャンした総ファイル数 - スキャン対象がディレクトリの場合、表示 | | `tableParams.objectstorageContentLength` | String | - | オブジェクトの長さ(Byte) | | `tableParams.objectstorageContentType` | String | - | オブジェクトのデータタイプ | | `tableParams.objectstorageLastModified` | String | - | オブジェクトの更新日時 - Unix Timestamp形式 | | `tableParams.partitioningScheme` | String | - | パーティショニングスキーマ - スキャン対象にパーティションが認識された場合、表示 | | `tableParams.scannerId` | String | - | スキャナー ID | | `tableParams.scannerName` | String | - | スキャナー名 | | `tableParams.skip.header.line.count` | String | - | 除外したヘッダライン数 | | `tableParams.totalSize` | String | - | スキャンした総データ量(Byte) - スキャン対象がディレクトリの場合、表示 | | `tableParams.transient_lastDdlTime` | String | - | テーブル DDLの更新日時 - Unix Timestamp形式 | 参考 テーブルタイプに応じて表示される属性情報が異なる場合があります。Apache Icebergテーブルの属性情報の詳細は、[Iceberg Table Metadata](https://iceberg.apache.org/spec/?utm_source=chatgpt.com#table-metadata)をご参照ください。 #### RDBデータの場合 RDB(MySQL、MSSQL、PostgreSQL)データの場合、追加で表示される属性の説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `{dbType}Collation` | String | - | 文字列ソート設定 | | `{dbType}DataSize` | String | - | データのサイズ | | `{dbType}IndexSize` | String | - | インデックスのサイズ | | `{dbType}Indexes` | String | - | インデックスの構造 | | `{dbType}Rows` | String | - | 行(レコード)数 | | `{dbType}TableSize` | String | - | テーブルの総サイズ | #### MongoDBデータの場合 MongoDBデータの場合、追加で表示される属性の説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `mongodbAvgObjSize` | String | - | コレクションのオブジェクトサイズの平均 | | `mongodbFreeStorageSize` | String | - | コレクションの空き容量 | | `mongodbIndexSize` | String | - | コレクションインデックスのサイズ | | `mongodbIndexes` | String | - | コレクションインデックス情報 | | `mongodbRowCount` | String | - | コレクション行(レコード)数 | | `mongodbSize` | String | - | コレクションサイズ - 圧縮されていないサイズ - インデックスサイズを除く | | `mongodbStorageSize` | String | - | コレクションに割り当てられたストレージ容量 | | `mongodbTotalSize` | String | - | コレクションの総ディスク容量 | ### レスポンスステータスコード Data Catalog APIで共通して使用されるレスポンスステータスコードの詳細は、[Data Catalogのレスポンスステータスコード](/docs/ja/analytics-datacatalog#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 ### レスポンス例 レスポンスのサンプルコードは次の通りです。 ``` { "storageFormatInfo": { "inputFormat": "org.apache.hadoop.mapred.TextInputFormat", "outputFormat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat", "serializationLib": "org.apache.hadoop.hive.serde2.OpenCSVSerde" }, "serdeParams": { "quoteChar": "\"", "escapeChar": "\\", "separatorChar": "," }, "tableParams": { "EXTERNAL": "TRUE", "compressionType": "", "created_time": "1743125379", "dataFormat": "csv", "dataType": "file", "isDirectory": "TRUE", "objectstorageContentLength": "2783", "objectstorageContentType": "text/csv", "objectstorageLastModified": "1743125017", "partitioningScheme": "hive", "scannerId": "9**", "scannerName": "scan_airQuality", "skip.header.line.count": "1", "transient_lastDdlTime": "1743125379" } } ```