getConnections

Prev Next

VPC環境で利用できます。

カタログ内のコネクションリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/catalogs/{catalogId}/connections

リクエストヘッダ

Data Catalog APIで共通して使用されるヘッダの詳細は、Data Catalogのリクエストヘッダをご参照ください。

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

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

フィールド タイプ 必須の有無 説明
catalogId Integer Required カタログ ID

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

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

フィールド タイプ 必須の有無 説明
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?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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
pageNo Integer - ページ番号
pageSize Integer - ページ表示数
totalCount Integer - レスポンス結果数
connectionResponseList Array - コネクションリスト

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のレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

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