getConnections
    • PDF

    getConnections

    • PDF

    기사 요약

    VPC 환경에서 이용 가능합니다.

    사용자 catalog의 모든 connection을 조회합니다.

    요청

    요청 URL

    GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/connections
    

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    catalogIdYesStringcatalog 고유 id
    (ref: getCatalogs)
    pageNoNoint페이지 번호
    기본값: 1
    pageSizeNoint최대값: 200결과 목록 크기
    기본값: 20
    searchValueNoStringconnection의 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 정보 리스트
    항목타입설명
    connectionIdintconnection 고유 id
    catalogIdintcatalog 고유 id
    nameStringconnection 이름
    descriptionStringconnection 설명
    typeStringconnection 유형
    connectionConfigJsonStringconnection 설정정보
    createTimeDateconnection 생성 일시
    updateTimeDateconnection 수정 일시
    참고

    connectionConfigJson은 connection 유형에 따라 json 형식이 달라질 수 있습니다.

    응답 예시

    HTTP

    HTTP StatusDescription
    200OK

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

    이 문서가 도움이 되었습니까?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.