getDatabases

Available in VPC

Get the list of databases in a catalog.

Request

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

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:

Request query parameters

You can use the following query parameters with your request:

Request example

The request example is as follows:

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases?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:

databaseResponseList

The following describes databaseResponseList.

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": 2,
    "requestId": "aff80286-****-****-****-6ac1d306b14a",
    "databaseResponseList": [
        {
            "catalogId": 4**,
            "name": "my_database",
            "description": "my database",
            "createTime": "2025-03-17T16:30:08+0900"
        },
        {
            "catalogId": 4**,
            "name": "default",
            "description": "Default Data Catalog database for test",
            "createTime": "2025-03-17T14:30:26+0900"
        }
    ]
}