MENU
      Get list of clusters using config group

        Get list of clusters using config group


        Article summary

        Available in VPC

        Description

        Get the list of clusters using a config group of Cloud Data Streaming Service.

        Request

        Request URL

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getConfigGroupUsingClusterList/{configGroupNo} [KR]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/configGroup/getConfigGroupUsingClusterList/{configGroupNo} [SGN]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/configGroup/getConfigGroupUsingClusterList/{configGroupNo} [JPN]
        HTTP

        Request headers

        Header nameDescription
        x-ncp-apigw-timestamp- This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC
        - Request is considered invalid if the timestamp differs from the current time by more than 5 minutes
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyValue of access key ID issued in the NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with the access key ID value and secret key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeSpecify the request body content type as application/JSON
        Content-Type: application/json

        Request parameter

        ParameterTypeRequiredDescription
        configGroupNoStringY- ConfigGroupNo
        - Target config group number
        pageNoIntegerNPage number to be displayed (default: 1)
        pageSizeIntegerNPage size to be displayed (default: 10)

        Request example

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getConfigGroupUsingClusterList/174
        HOST: clouddatastreamingservice.apigw.ntruss.com
        Content-Type: application/json
        x-ncp-apigw-signature-v2: uLWYAZULzt3UZl5MeUo5Xj1mepW49qSMKc9n2rMv/YA=
        x-ncp-apigw-timestamp: 1653981745173
        x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
        
        {
          "pageNo": 1,
          "pageSize": 10
        }
        HTTP
        curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getConfigGroupUsingClusterList/174" \
        -H "accept: application/json" \
        -H "Content-Type: application/json" \
        -H "x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2" \
        -H "x-ncp-apigw-timestamp: 1653981745173" \
        -H "x-ncp-apigw-signature-v2: uLWYAZULzt3UZl5MeUo5Xj1mepW49qSMKc9n2rMv/YA=" \
        -d \
        '{
          "pageNo": 1,
          "pageSize": 10
        }'
        Bash

        Response parameter

        public class GetConfigGroupUsingClusterListResponseVo {
            private Integer currentPage;
            private Boolean isFirst;
            private Boolean isLast;
            private Integer pageSize;
            private Long totalCount;
            private Integer totalPage;
            private List<usingClusterNameList> ConfigGroupClusterInfo;
        }
        
        public class usingClusterNameList {
            private String clusterName;
            private Integer serviceGroupInstanceNo;
        }
        Java

        Field

        Parameter nameTypeDescription
        currentPageIntegerCurrent page number
        isFirstBooleanIt indicates whether this is the first page
        isLastBooleanIt indicates whether this is the last page
        pageSizeIntegerNumber of data to be displayed on the page
        totalCountLongTotal number of data queried
        totalPageIntegerTotal page count (totalCount/pageSize)
        kafkaConfigGroupListList<usingClusterNameList>List of clusters that are using the config group
        serviceGroupInstanceNoIntegerCluster instance number
        clusterNameStringCluster name

        Response examples (success)

        {
          "code": 0,
          "message": "SUCCESS",
          "result": {
            "currentPage": 1,
            "isFirst": true,
            "isLast": true,
            "pageSize": 10,
            "totalCount": 2,
            "totalPage": 1,
            "usingClusterNameList": [
              {
                "clusterName": "cluster-sample1",
                "serviceGroupInstanceNo": 2389832
              },
              {
                "clusterName": "cluster-sample2",
                "serviceGroupInstanceNo": 2389848
              }
            ]
          },
          "requestId": "86f64c9b-053a-4069-94c9-644ece14b506"
        }
        JSON

        Was this article helpful?

        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.