リクエスト

リクエスト URL

GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/databases/{database-name}/tables/{table-name}

リクエストパラメータ

パラメータ名	必須有無	タイプ	制限事項	説明
catalogId	Yes	String	catalogの固有 id (ref: getCatalogs)
databaseName	Yes	String		database名
tableName	Yes	String		table名

リクエストヘッダ

共通ガイドを参照

リクエスト例

curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/databases/{database-name}/tables/{table-name}" \
    -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}" \
    -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"  \
    -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"

レスポンス

レスポンスボディ

項目	タイプ	説明
catalogId	Int	catalogの固有 id
databaseName	String	database名
tableName	String	table名
dataFormat	String	tableのデータ形式
location	String	tableの位置
description	String	説明
createTime	Date	tableの作成日時
updateTime	Date	tableの修正日時
properties.EXTERNAL	String	外部保存の有無
properties.connectionId	String	スキャンのために利用したコネクションの固有 ID
properties.connectionName	String	スキャンのために利用したコネクション名
properties.created_time	String	tableの作成日時
properties.dataFormat	String	データソースの形式
properties.dataType	String	データソースタイプ
properties.delimiter	String	ソースデータが CSVファイルの場合に区分記号
properties.inputFormat	String	Fileを Objectで読み取るための Format形式
properties.isDirectory	String	スキャン対象のディレクトリ有無
properties.last_modified_time	String	tableの修正日時
properties.numFiles	String	ディレクトリの場合、スキャンした総ファイル数
properties.outputFormat	String	Objectを Fileで書き込むための Format形式
properties.scannerId	String	tableを作成したスキャナー ID
properties.scannerName	String	tableを作成したスキャナー名
properties.serializationLib	String	Serializer and Deserializer Library
properties.totalSize	String	ディレクトリの場合、スキャンした総データ容量
properties.transient_lastDdlTime	String	tableの DDLの最終変更日時

RDBの場合、追加の properties

項目	タイプ	説明
properties.{dbType}Collation	String	テーブルの collation
properties.{dbType}DataSize	String	テーブルに保存されたデータサイズ
properties.{dbType}IndexSize	String	テーブルのインデックスサイズ
properties.{dbType}Indexes	String	テーブルに設定したインデックス情報
properties.{dbType}Rows	String	テーブルの row数
properties.{dbType}TableSize	String	テーブル全体のサイズ

MongoDBの場合、追加の properties

項目	タイプ	説明
properties.mongodbAvgObjSize	String	コレクションの平均オブジェクトサイズ
properties.mongodbFreeStorageSize	String	コレクションの保存可能サイズ
properties.mongodbIndexSize	String	コレクションのインデックスサイズ
properties.mongodbIndexes	String	コレクションのインデックス情報
properties.mongodbRowCount	String	コレクションの row数
properties.mongodbSize	String	コレクションの非圧縮サイズ (index sizeを除く)
properties.mongodbStorageSize	String	コレクションに割り当てられた総ストレージサイズ
properties.mongodbTotalSize	String	コレクション全体のディスク使用量 (storage size + index size)

レスポンス例

HTTP

HTTP Status	Description
200	OK

JSON

{
  "catalogId": 2144,
  "databaseName": "default",
  "tableName": "scan_dir",
  "dataFormat": "csv",
  "location": "s3a://bububu/scan-dir/",
  "description": "test table description",
  "createTime": "2023-03-29T14:12:37+0900",
  "updateTime": "2023-06-02T14:01:30+0900",
  "properties": {
    "EXTERNAL": "TRUE",
    "connectionName": "bububu-conn",
    "created_time": "1680066757",
    "dataFormat": "csv",
    "dataType": "file",
    "delimiter": ",",
    "inputFormat": "org.apache.hadoop.mapred.TextInputFormat",
    "isDirectory": "TRUE",
    "last_modified_time": "1685682090",
    "numFiles": "1",
    "outputFormat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
    "scannerId": "283",
    "scannerName": "bububu-scanner",
    "serializationLib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
    "totalSize": "8402",
    "transient_lastDdlTime": "1680066757"
  }
}

この記事は役に立ちましたか?

リクエスト
レスポンス
- レスポンスボディ
- レスポンス例

タグ

Data Catalog