getConnections
- 印刷する
- PDF
getConnections
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
ユーザー catalogのすべての connectionを照会します。
リクエスト
リクエスト URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/connections
リクエストパラメータ
| パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| catalogId | Yes | String | catalogの固有 id (ref: getCatalogs) | |
| pageNo | No | int | ページ番号 デフォルト値: 1 | |
| pageSize | No | int | 最大値: 200 | 結果リストのサイズ デフォルト値: 20 |
| searchValue | No | String | connectionの name / description検索キーワード |
リクエストヘッダ
リクエスト例
curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/connections?pageNo=1&pageSize=20" \
-H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}" \
-H "x-ncp-iam-access-key: {x-ncp-iam-access-key}" \
-H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
レスポンス
レスポンスボディ
- connectionResponseList: ユーザー catalogの connection情報リスト
| 項目 | タイプ | 説明 |
|---|---|---|
| connectionId | int | connectionsの固有 id |
| catalogId | int | catalogの固有 id |
| name | String | connection名 |
| description | String | connectionの説明 |
| type | String | connectionのタイプ |
| connectionConfigJson | String | connectionの設定情報 |
| createTime | Date | connectionの作成日時 |
| updateTime | Date | connectionの修正日時 |
参考
connectionConfigJsonは、connectionのタイプによって json形式が異なることがあります。
レスポンス例
HTTP
| HTTP Status | Description |
|---|---|
| 200 | OK |
JSON
{
"pageNo": 1,
"pageSize": 20,
"totalCount": 1,
"connectionResponseList": [
{
"connectionId": 87,
"catalogId": 301,
"name": "datacatalog-connection",
"description": "datacatalog service connection description",
"type": "OBJECT_STORAGE",
"connectionConfigJson": {
"clusterNo": 0,
"clusterName": "test",
"dbPort": 0,
"regionNo": 1,
"bucketName": "datacatalog-test-bucket"
},
"createTime": "2022-12-07T01:31:19+0900",
"updateTime": "2023-04-10T14:01:56+0900"
}
]
}
この記事は役に立ちましたか?