getConnections
    • PDF

    getConnections

    • PDF

    Article summary

    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 nameRequirement statusTypeRestrictionsDescription
    catalogIdYesStringUnique catalog ID
    (ref: getCatalogs)
    pageNoNointPage number
    Default: 1
    pageSizeNointMaximum: 200size of result list
    Default: 20
    searchValueNoStringSearch term for the name/description of the connection

    Request header

    See common guide.

    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
    ItemTypeDescription
    connectionIdintUnique connection ID
    catalogIdintUnique catalog ID
    nameStringConnection name
    descriptionStringConnection description
    typeStringConnection type
    connectionConfigJsonStringConnection setting information
    createTimeDateConnection creation date and time
    updateTimeDateConnection modification date and time
    Note

    The JSON format of connectionConfigJson may vary depending on the connection type.

    Response examples

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

    Was this article helpful?

    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.