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 | connection 고유 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"
}
]
}
이 문서가 도움이 되었습니까?