---
title: "getConnections"
slug: "analytics-datacatalog-connection-getconnections"
updated: 2026-09-17T09:16:09Z
published: 2026-09-17T09:16:09Z
canonical: "api.ncloud-docs.com/analytics-datacatalog-connection-getconnections"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# getConnections

VPC 환경에서 이용 가능합니다.

카탈로그 내 커넥션 목록을 조회합니다.

## 요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

| 메서드 | URI |
| --- | --- |
| GET | /api/v1/catalogs/{catalogId}/connections |

### 요청 헤더

Data Catalog API에서 공통으로 사용하는 헤더에 대한 정보는 [Data Catalog 요청 헤더](/docs/analytics-datacatalog#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오.

### 요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `catalogId` | Integer | Required | 카탈로그 아이디 - [getCatalogs](/docs/analytics-datacatalog-catalog-getcatalogs) 참조 |

### 요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `pageNo` | Integer | Optional | 페이지 번호 - 1~N (기본값: 1) |
| `pageSize` | Integer | Optional | 페이지 출력 수 - 1~200 (기본값: 20) |
| `searchValue` | String | Optional | 검색 키워드 - 커넥션 이름 또는 설명으로 검색 가능 - 한글 입력 시 URL 인코딩 필요 |

### 요청 예시

요청 예시는 다음과 같습니다.

```
curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/connections?pageNo=1&pageSize=20&searchValue=connect' \
--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 | - | 응답 결과 수 |
| `connectionResponseList` | Array | - | 커넥션 목록: [connectionResponseList](/docs/analytics-datacatalog-connection-getconnections#connectionResponseList) |

#### `connectionResponseList`

`connectionResponseList`에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `connectionId` | Integer | - | 커넥션 아이디 |
| `catalogId` | Integer | - | 카탈로그 아이디 |
| `name` | String | - | 커넥션 이름 |
| `description` | String | - | 커넥션 설명 |
| `type` | String | - | 데이터 유형 |
| `connectionConfigJson` | Object | - | 데이터 상세 정보 |
| `connectionConfigJson.clusterNo` | Integer | - | 데이터베이스 서비스 번호 |
| `connectionConfigJson.clusterName` | String | - | 데이터베이스 서비스 이름 |
| `connectionConfigJson.jdbcUrl` | String | - | JDBC(Java Database Connectivity) 접근 URL - `type`이 `JDBC`인 경우, 표시 |
| `connectionConfigJson.databaseName` | String | - | 데이터베이스 이름 |
| `createTime` | String | - | 커넥션 생성 일시 - ISO 8601 형식 |
| `updateTime` | String | - | 업데이트 일시 - ISO 8601 형식 |

참고

`connectionConfigJson`은 커넥션 유형에 따라 JSON 형식이 달라질 수 있습니다.

### 응답 상태 코드

Data Catalog API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Data Catalog 응답 상태 코드](/docs/analytics-datacatalog#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오.

### 응답 예시

응답 예시는 다음과 같습니다.

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