MENU
      Modify Config Group description

        Modify Config Group description


        Article summary

        It is available in a VPC environment.

        Description

        Edits the description of a Cloud Data Streaming Service config group.

        Request

        Request URL

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/setKafkaConfigGroupMemo/{ConfigGroupNo} [KR]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/setKafkaConfigGroupMemo/{ConfigGroupNo} [SGN]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/setKafkaConfigGroupMemo/{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.
        descriptionStringN- ConfigGroup description
        Description that can be written as needed by the user

        Request examples

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/setKafkaConfigGroupMemo/236
        HOST: clouddatastreamingservice.apigw.ntruss.com
        Content-Type: application/json
        x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
        x-ncp-apigw-timestamp: 1593848345548
        x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
        
        {
          "kafkaVersionCode": "2403005",
          "description": "Add description modifications "
        }
        HTTP
        curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/setKafkaConfigGroupMemo/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",
          "description": "Add description modifications "
        }'
        Bash

        Response examples

        {
          "code": 0,
          "message": "SUCCESS",
          "result": true,
          "requestId": "66b49f42-e082-44b4-8363-fd3c8bc63ac0"
        }
        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.