getTables

Prev Next

Available in VPC

Get the list of tables in a catalog.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/catalogs/{catalogId}/tables

Request headers

For information about the headers common to all Data Catalog APIs, see Data Catalog request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
catalogId Integer Required Catalog ID

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
pageNo Integer Optional Page number
  • 1-N (default: 1)
pageSize Integer Optional Page output count
  • 1-200 (default: 20)
databaseName String Optional Filter by database name.
tableName String Optional Filter by table name.
location String Optional Filter by location string.
tagKeyValue String Optional Filter by tag key and value.
  • Enter in the form of {key}:{value}.
dataFormats String Optional Filter by data format.
  • 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 Sort by field
  • tableName | databaseName | createTime
    • tableName: table name
    • databaseName: database name
    • createTime: table creation date and time
sort.isAsc Boolean Optional Whether ascending or descending
  • true | false
    • true: ascending
    • false: descending

Request example

The request example is as follows:

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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
pageNo Integer - Page number
pageSize Integer - Page output count
totalCount Integer - Number of response results
requestId String - ID for the request
  • UUID format
tableResponseList Array - Table list

tableResponseList

The following describes tableResponseList.

Field Type Required Description
catalogId Integer - Catalog ID
tableName String - Table name
databaseName String - Database name
location String - Table location
dataFormat String - Data format
createTime String - Table creation date and time
  • ISO 8601 format
updateTime String - Update date and time
  • ISO 8601 format

Response status codes

For response status codes common to all Data Catalog APIs, see Data Catalog response status codes.

Response example

The response example is as follows:

{
    "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"
        }
    ]
}