MENU
      Save Config Group Kafka properties settings

        Save Config Group Kafka properties settings


        Article summary

        It is available in a VPC environment.

        Description

        Edits the config details for a Cloud Data Streaming Service config group.

        Request

        Request URL

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/setKafkaConfigGroupDetail/{ConfigGroupNo} [KR]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/setKafkaConfigGroupDetail/{ConfigGroupNo} [SGN]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/setKafkaConfigGroupDetail/{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
        configGroupNoStringYConfigGroupNo
        Number of the target ConfigGroup
        kafkaVersionCodeStringYCloud Data Streaming Service version to be used
        It can be acquired through the getCDSSVersion action.
        autoCreateTopicsEnableBooleanNRefer to Kafka config (default: true)
        deleteTopicEnableBooleanNRefer to Kafka config (default: true)
        logCleanerEnableBooleanNRefer to Kafka config (default: true)
        logCleanupPolicyStringNRefer to Kafka config (default: delete)
        logCleanerThreadsIntegerNRefer to Kafka config (default: 1)
        logFlushIntervalMessagesLongNRefer to Kafka config (default: 9223372036854775807)
        logRetentionBytesLongNRefer to Kafka config (default: -1)
        logRetentionHoursIntegerNRefer to Kafka config (default: 168)
        logSegmentBytesIntegerNRefer to Kafka config (default: 1073741824)
        numIoThreadsIntegerNRefer to Kafka config (default: 8)
        numNetworkThreadsIntegerNRefer to Kafka config (default: 3)
        numPartitionsIntegerNRefer to Kafka config (default: 3)
        allowEveryoneIfNoAclFoundBooleanNRefer to Kafka config (default: true)

        Request examples

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/setKafkaConfigGroupDetail/174
        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",
          "autoCreateTopicsEnable": true,
          "deleteTopicEnable": true,
          "logCleanerEnable": true,
          "logCleanupPolicy": "delete",
          "logCleanerThreads": 1,
          "logFlushIntervalMessages": 9223372036854775807,
          "logRetentionBytes":-1,
          "logRetentionHours": 168,
          "logSegmentBytes": 1073741824,
          "numIoThreads": 8,
          "numNetworkThreads": 3,
          "numPartitions": 3,
          "allowEveryoneIfNoAclFound": true
        }
        HTTP
        curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/setKafkaConfigGroupDetail/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 \
        '{
          "kafkaVersionCode": "2403005",
          "autoCreateTopicsEnable": true,
          "deleteTopicEnable": true,
          "logCleanerEnable": true,
          "logCleanupPolicy": "delete",
          "logCleanerThreads": 1,
          "logFlushIntervalMessages": 9223372036854775807,
          "logRetentionBytes":-1,
          "logRetentionHours": 168,
          "logSegmentBytes": 1073741824,
          "numIoThreads": 8,
          "numNetworkThreads": 3,
          "numPartitions": 3,
          "allowEveryoneIfNoAclFound": true
        }'
        Bash

        Response examples

        {
          "code": 0,
          "message": "SUCCESS",
          "result": {
            "configGroupNo": 174
          },
          "requestId": "3487ee91-4a54-49c8-8ea8-cddc447e4285"
        }
        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.