getConnections

Prev Next

Available in VPC

Get the list of connections in a catalog.

Request

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

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

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)
searchValue String Optional Search keyword
  • Search by connection name or description
  • URL encoding required when entering Korean

Request example

The request example is as follows:

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/connections?searchValue=connect&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
connectionResponseList Array - Connection list

connectionResponseList

The following describes connectionResponseList.

Field Type Required Description
connectionId Integer - Connection ID
catalogId Integer - Catalog ID
name String - Connection name
description String - Connection description
type String - Data type
connectionConfigJson Object - Data details
connectionConfigJson.clusterNo Integer - Database service number
connectionConfigJson.clusterName String - Database service name
connectionConfigJson.jdbcUrl String - JDBC (Java Database Connectivity) access URL
  • Displayed if type is JDBC.
connectionConfigJson.databaseName String - Database name
createTime String - Connection creation date and time
  • ISO 8601 format
updateTime String - Update date and time
  • ISO 8601 format
Note

The connectionConfigJson JSON format may vary depending on the connection type.

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": 3,
    "connectionResponseList": [
        {
            "connectionId": 6**,
            "catalogId": 4**,
            "name": "connect_mongodb",
            "description": "Connection to MongoDB",
            "type": "CLOUD_DB_FOR_MONGODB",
            "connectionConfigJson": {
                "clusterNo": 10*****24,
                "clusterName": "test",
                "databaseName": "test"
            },
            "createTime": "2025-03-18T16:21:29+0900",
            "updateTime": "2025-03-19T16:30:18+0900"
        },
        {
            "connectionId": 6**,
            "catalogId": 4**,
            "name": "connect2_mysql",
            "description": "Connection to mysql cluster",
            "type": "CLOUD_DB_FOR_MYSQL",
            "connectionConfigJson": {
                "clusterNo": 10*****40,
                "clusterName": "test2",
                "databaseName": "my_db"
            },
            "createTime": "2025-03-18T14:35:01+0900"
        },
        {
            "connectionId": 6**,
            "catalogId": 4**,
            "name": "connect_mysql",
            "description": "Connection to MySQL",
            "type": "CLOUD_DB_FOR_MYSQL",
            "connectionConfigJson": {
                "clusterNo": 10*****26,
                "clusterName": "test",
                "databaseName": "basic"
            },
            "createTime": "2025-03-18T11:58:51+0900"
        }
    ]
}