getConnection

VPC環境で利用できます。

コネクションの詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	Required	カタログ ID getCatalogsを参照
`connectionId`	Integer	Required	コネクション ID getConnectionsを参照

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/connections/6**' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`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のレスポンスステータスコードをご参照ください。

レスポンス例

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

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