---
title: "getConnections"
slug: "analytics-datacatalog-connection-getconnections"
tags: ["Data Catalog"]
updated: 2026-09-17T09:57:35Z
published: 2026-09-17T09:57:35Z
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/ja/analytics-datacatalog#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `catalogId` | Integer | Required | カタログ ID - [getCatalogs](/docs/ja/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/ja/analytics-datacatalog-connection-getconnections#connectionResponseList) |

#### `connectionResponseList`

`connectionResponseList`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `connectionId` | Integer | - | コネクション ID |
| `catalogId` | Integer | - | カタログ ID |
| `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/ja/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"
        }
    ]
}
```