MENU
      View Config Group information

        View Config Group information


        Article summary

        It is available in a VPC environment.

        Description

        Views the information of a Cloud Data Streaming Service config group.

        Request

        Request URL

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

        Request header

        Header nameDescription
        x-ncp-apigw-timestampThis is the number of milliseconds that have elapsed 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-keyValue of access key ID issued on 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-TypeSpecifies the request body content type as application/json
        Content-Type: application/json

        Request parameter

        ParameterTypeRequirement statusDescription
        configGroupNoStringY- ConfigGroupNo
        Number of the target ConfigGroup
        kafkaVersionCodeStringY- Cloud Data Streaming Service version to be used
        It can be acquired through the getCDSSVersion action.

        Request examples

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getKafkaConfigGroup/236
        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"
        }
        HTTP
        curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getKafkaConfigGroup/236" \
        -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"
        }'
        Bash

        Response parameter

        public class GetKafkaConfigGroupResponseVo{
            private Integer configGroupNo;
            private String memberNo;
            private String configGroupName;
            private String kafkaVersionCode;
            private String description;
        }
        Java

        Field

        Parameter nameTypeDescription
        configGroupNoIntegerConfigGroup number
        memberNoStringMember number
        configGroupNameStringConfigGroup name
        kafkaVersionCodeStringKafka version code that can be used in ConfigGroup
        descriptionStringUser description

        Response examples (success)

        {
          "code": 0,
          "message": "SUCCESS",
          "result": {
            "configGroupNo": 236,
            "memberNo": "46",
            "configGroupName": "configgroup-1",
            "kafkaVersionCode": "2403005",
            "description": "Config group 1"
          },
          "requestId": "b3dcf8e3-4111-4ac4-92e1-b80280fb160d"
        }
        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.