getTablesByDatabase

Prev Next

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
catalogId Integer Required カタログ ID
databaseName String Required データベース名

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

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

フィールド タイプ 必須の有無 説明
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/my_database/tables?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": 2,
    "requestId": "570aad8d-****-****-****-898f3c1bd0d6",
    "tableResponseList": [
        {
            "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": "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"
        }
    ]
}