getConnections
- Print
- PDF
getConnections
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Searches for all connections in the user’s catalog.
Requests
Request URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/connections
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| catalogId | Yes | String | Unique catalog ID (ref: getCatalogs) | |
| pageNo | No | int | Page number Default: 1 | |
| pageSize | No | int | Maximum: 200 | size of result list Default: 20 |
| searchValue | No | String | Search term for the name/description of the connection |
Request header
Request examples
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}"
Responses
Response bodies
- connectionResponseList: connection information list of the user’s catalog
| Item | Type | Description |
|---|---|---|
| connectionId | int | Unique connection ID |
| catalogId | int | Unique catalog ID |
| name | String | Connection name |
| description | String | Connection description |
| type | String | Connection type |
| connectionConfigJson | String | Connection setting information |
| createTime | Date | Connection creation date and time |
| updateTime | Date | Connection modification date and time |
Note
The JSON format of connectionConfigJson may vary depending on the connection type.
Response examples
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"
}
]
}
Was this article helpful?