Get config group Kafka settings

Prev Next

Available in VPC

Get detailed Kafka settings for a config group.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v1/configGroup/getKafkaConfigGroupDetailList/{configGroupNo} (Korea Region)
POST /api/sgn-v1/configGroup/getKafkaConfigGroupDetailList/{configGroupNo} (Singapore Region)
POST /api/jpn-v1/configGroup/getKafkaConfigGroupDetailList/{configGroupNo} (Japan Region)

Request headers

For information about the headers common to all Cloud Data Streaming Service APIs, see Cloud Data Streaming Service request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
configGroupNo Integer Required Config group number

Request body

You can include the following data in the body of your request:

Field Type Required Description
kafkaVersionCode Integer Required Kafka version code

Request example

The request example is as follows:

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaConfigGroupDetailList/3**' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "kafkaVersionCode": "3903006"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
code Integer - Response code
message String - Response message
result Object - Response result
result.memberNo String - User's NAVER Cloud Platform member ID
result.configGroupNo Integer - Config group number
result.kafkaVersionCode String - Kafka version code
result.additionalKafkaConfigGroupDetailList Array - List of custom detailed settings
result.kafkaConfigGroupDetailList Array - Detailed settings list
requestId String - ID for the request
  • UUID format

additionalKafkaConfigGroupDetailList

The following describes additionalKafkaConfigGroupDetailList.

Field Type Required Description
configName String - Config name
  • Name used for Kafka configuration file (Serverproperties)
type String - Config data type
range String - Config value range
defaultValue String - Config default
configValue String - Config custom value
modifyYn Boolean - Whether user modification is available
  • true | false
    • true: available
    • false: unavailable

kafkaConfigGroupDetailList

The following describes kafkaConfigGroupDetailList.

Field Type Required Description
configNameKey String - Config name key
configName String - Config name
  • Name used for Kafka configuration file (Serverproperties)
type String - Config data type
defaultValue String - Config default
range String - Config value range
customValue String - Config custom value
modifyYn Boolean - Whether user modification is available
  • true | false
    • true: available
    • false: unavailable

Response status codes

For information about the HTTP status codes common to all Cloud Data Streaming Service APIs, see Cloud Data Streaming Service response status codes.

Response example

The response example is as follows:

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "memberNo": "500****",
        "configGroupNo": 3**,
        "kafkaVersionCode": "3903006",
        "additionalKafkaConfigGroupDetailList": [
            {
                "configName": "compression.type",
                "type": "String",
                "range": "[\"lz4\", \"zstd\"]",
                "defaultValue": "lz4",
                "configValue": "",
                "modifyYn": true
            }
        ],
        "kafkaConfigGroupDetailList": [
            {
                "configNameKey": "autoCreateTopicsEnable",
                "configName": "auto.create.topics.enable",
                "type": "Boolean",
                "defaultValue": "true",
                "range": "",
                "customValue": null,
                "modifyYn": true
            },
            {
                "configNameKey": "deleteTopicEnable",
                "configName": "delete.topic.enable",
                "type": "Boolean",
                "defaultValue": "true",
                "range": "",
                "customValue": null,
                "modifyYn": true
            },
            {
                "configNameKey": "offsetsTopicReplicationFactor",
                "configName": "offsets.topic.replication.factor",
                "type": "Integer",
                "defaultValue": "3",
                "range": "1~128",
                "customValue": null,
                "modifyYn": true
            },
            ...
        ]
    },
    "requestId": "1dff09ee-****-****-****-236257061888"
}