getTables

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	Required	カタログ ID getCatalogsを参照

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSize`	Integer	Optional	ページの出力数 1~200 (デフォルト: 20)
`databaseName`	String	Optional	データベース名で絞り込み
`tableName`	String	Optional	テーブル名で絞り込み
`location`	String	Optional	位置文字列で絞り込み
`tagKeyValue`	String	Optional	タグキーと値で絞り込み `{key}:{value}`形式で入力
`dataFormats`	String	Optional	データ形式で絞り込み `csv` \| `json` \| `xml` \| `parquet` \| `avro` \| `orc` \| `unknown` \| `CLOUD_DB_FOR_MYSQL` \| `CLOUD_DB_FOR_MSSQL` \| `CLOUD_DB_FOR_MONGODB` \| `CLOUD_DB_FOR_POSTGRESQL` \| `JDBC`
`sort.field`	String	Optional	ソートの基準フィールド `tableName` \| `databaseName` \| `createTime` `tableName`: テーブル名 `databaseName`: データベース名 `createTime`: テーブルの作成日時
`sort.isAsc`	Boolean	Optional	昇順かどうか `true` \| `false` `true`: 昇順 `false`: 降順

リクエスト例

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

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/tables?sort.field=createTime&sort.isAsc=true&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	-	レスポンス結果数
`requestId`	String	-	リクエスト ID UUID形式
`tableResponseList`	Array	-	テーブルリスト

`tableResponseList`

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

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	-	カタログ ID
`tableName`	String	-	テーブル名
`databaseName`	String	-	データベースの名前
`location`	String	-	テーブルの位置
`dataFormat`	String	-	データ形式
`createTime`	String	-	テーブルの作成日時 ISO 8601形式
`updateTime`	String	-	更新日時 ISO 8601形式

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

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

レスポンス例

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

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 4,
    "requestId": "ba13ad99-****-****-****-eeb2a4f0d032",
    "tableResponseList": [
        {
            "catalogId": 4**,
            "tableName": "db_metadata_json",
            "databaseName": "my_database",
            "location": "s3a://datacatalog-c***-e******f/db_metadata.json",
            "dataFormat": "json",
            "createTime": "2025-03-17T16:30:43+0900",
            "updateTime": "2025-03-18T10:12:18+0900"
        },
        {
            "catalogId": 4**,
            "tableName": "employeelist",
            "databaseName": "my_database",
            "location": "s3a://datacatalog-c***-e******f/my_database/employeeList",
            "dataFormat": "csv",
            "createTime": "2025-03-18T09:31:32+0900",
            "updateTime": "2025-03-18T09:52:11+0900"
        },
        {
            "catalogId": 4**,
            "tableName": "employeelist",
            "databaseName": "default",
            "location": "s3a://datacatalog-c***-e******f/my_database/employeeList/",
            "dataFormat": "csv",
            "createTime": "2025-03-18T09:34:52+0900",
            "updateTime": "2025-03-18T09:42:28+0900"
        },
        {
            "catalogId": 4**,
            "tableName": "log_table_1",
            "databaseName": "log_database",
            "location": "s3a://datacatalog-c***-e******f/log_database/log_table_1",
            "dataFormat": "json",
            "createTime": "2025-03-18T10:05:59+0900",
            "updateTime": "2025-03-18T10:09:31+0900"
        }
    ]
}