Change config group Kafka settings

Available in VPC

Change 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/setKafkaConfigGroupDetail/{configGroupNo} (Korea Region)
POST	/api/sgn-v1/configGroup/setKafkaConfigGroupDetail/{configGroupNo} (Singapore Region)
POST	/api/jpn-v1/configGroup/setKafkaConfigGroupDetail/{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 See Get config group list.

Request body

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

Field	Type	Required	Description
`kafkaVersionCode`	Integer	Required	Kafka version code See Get version.
`autoCreateTopicsEnable`	Boolean	Optional	Whether topic auto-generation is enabled `true` (default) \| `false` `true`: enabled `false`: disabled See Kafka Documentation.
`deleteTopicEnable`	Boolean	Optional	Whether topic deletion is enabled `true` (default) \| `false` `true`: enabled `false`: disabled See Kafka Documentation.
`offsetsTopicReplicationFactor`	Integer	Optional	Replication factor applied to offset topics 1-128 (default: 3) See Kafka Documentation.
`logCleanerEnable`	Boolean	Optional	Whether log cleaner process is enabled `true` (default) \| `false` `true`: enabled `false`: disabled See Kafka Documentation.
`logCleanupPolicy`	String	Optional	Cleanup policy for logs that have exceeded their retention period `delete` (default) \| `compact` See Kafka Documentation.
`logCleanerThreads`	Integer	Optional	Number of background threads to perform log cleanup 1-100 (default: 1) See Kafka Documentation.
`logFlushIntervalMessages`	Number	Optional	Number of accumulated messages before performing disk flush 1-9223372036854775807 (default: 9223372036854775807) See Kafka Documentation.
`logRetentionBytes`	Number	Optional	Maximum log retention capacity 1-N (default: -1) See Kafka Documentation.
`logRetentionHours`	Integer	Optional	Log retention time (hour) 1-168 (default: 168) See Kafka Documentation.
`logSegmentBytes`	Integer	Optional	Maximum single log capacity (byte) 14-2147483647 (default: 1073741824) See Kafka Documentation.
`numIoThreads`	Integer	Optional	Number of threads used to process server requests 1-2147483647 (default: 8) Disk I/O included See Kafka Documentation.
`numNetworkThreads`	Integer	Optional	Number of threads used to receive requests from the server and send responses 1-2147483647 (default: 3) See Kafka Documentation.
`numPartitions`	Integer	Optional	Number of log partitions by topic 1-128 (default: 3) See Kafka Documentation.
`authorizerClassName`	String	Optional	Full path of the class responsible for authorization `kafka.security.authorizer.AclAuthorizer` (default) See Kafka Documentation.
`allowEveryoneIfNoAclFound`	Boolean	Optional	Allow all access when ACL is missing `true` (default) \| `false` `true`: allow `false`: block See Kafka Documentation.

Request example

The request example is as follows:

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/setKafkaConfigGroupDetail/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",
    "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
}'

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.configGroupNo`	Integer	-	Config group number
`requestId`	String	-	ID for the request UUID format

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": {
        "configGroupNo": 3**
    },
    "requestId": "548a94cf-****-****-****-53536d7cb48f"
}