MENU
      View list of ConfigGroup for each Kafka version

        View list of ConfigGroup for each Kafka version


        Article summary

        Available in VPC

        Description

        View available ConfigGroup information depending on the Kafka version of the Cloud Data Streaming Service.

        Requests

        Request URL

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

        Request Headers

        Header nameDescription
        x-ncp-apigw-timestamp- Time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC
        - If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyAccess key ID issued on NAVER Cloud Platform
        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-TypeSet the request body content type to application/json
        Content-Type: application/json

        Request parameters

        ParametersTypeRequirement statusDescription
        kafkaVersionCodeStringY- Cloud Data Streaming Service version being used
        - It can be acquired through the getCDSSVersion action
        pageNoIntegerNPage number to be displayed (default: 1)
        pageSizeIntegerNPage size to be displayed (default: 10)

        Request examples

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaVersionConfigGroupList
        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
        
        {
          "kafkaVersionCode": "2403005",
          "pageNo": 1,
          "pageSize": 10
        }
        HTTP
        curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaVersionConfigGroupList" \
        -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 \
        '{
          "kafkaVersionCode": "2403005",
          "pageNo": 1,
          "pageSize": 10
        }'
        Bash

        Response parameter

        public class GetKafkaConfigGroupListResponseVo {
            private Integer currentPage;
            private Boolean isFirst;
            private Boolean isLast;
            private Integer pageSize;
            private Long totalCount;
            private Integer totalPage;
            private List<KafkaConfigGroup> KafkaConfigGroupList;
        }
        
        public class KafkaConfigGroup {
            private String kafkaVersionCode;
            private String kafkaVersion;
            private Integer configGroupNo;
            private String configGroupName;
            private String description;
        }
        Java

        Field

        Parameter nameTypeDescription
        currentPageIntegerCurrent page number
        isFirstBooleanIndicates whether this is the first page
        isLastBooleanIndicates whether this is the last page
        pageSizeIntegerNumber of data displayed on the page
        totalCountLongTotal number of data searched
        totalPageIntegerNumber of all pages (totalCount/pageSize)
        kafkaConfigGroupListList<KafkaConfigGroup>List of ConfigGroup
        kafkaVersionCodeString- Cloud Data Streaming Service version
        - It can be acquired through the getCDSSVersion action
        kafkaVersionStringKafka version actually used in a cluster
        configGroupNoIntegerConfigGroup number
        configGroupNameStringConfigGroup name
        descriptionStringUser description of ConfigGroup

        Response examples (success)

        {
          "code": 0,
          "message": "SUCCESS",
          "result": {
            "currentPage": 1,
            "isFirst": true,
            "isLast": true,
            "pageSize": 10,
            "totalCount": 2,
            "totalPage": 1,
            "kafkaConfigGroupList": [
              {
                "kafkaVersionCode": "2403005",
                "kafkaVersion": "2.4.0",
                "configGroupNo": 174,
                "configGroupName": "config-test",
                "description": "actual test"
              },
              {
                "kafkaVersionCode": "2403005",
                "kafkaVersion": "2.4.0",
                "configGroupNo": 236,
                "configGroupName": "ttttetetet",
                "description": "Description edit added "
              }
            ]
          },
          "requestId": "e1b45201-d865-416d-af16-a7dea176a727"
        }
        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.