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 |
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
kafkaVersionCode |
Integer | Required | Kafka version code
|
autoCreateTopicsEnable |
Boolean | Optional | Whether topic auto-generation is enabled
|
deleteTopicEnable |
Boolean | Optional | Whether topic deletion is enabled
|
offsetsTopicReplicationFactor |
Integer | Optional | Replication factor applied to offset topics
|
logCleanerEnable |
Boolean | Optional | Whether log cleaner process is enabled
|
logCleanupPolicy |
String | Optional | Cleanup policy for logs that have exceeded their retention period
|
logCleanerThreads |
Integer | Optional | Number of background threads to perform log cleanup
|
logFlushIntervalMessages |
Number | Optional | Number of accumulated messages before performing disk flush
|
logRetentionBytes |
Number | Optional | Maximum log retention capacity
|
logRetentionHours |
Integer | Optional | Log retention time (hour)
|
logSegmentBytes |
Integer | Optional | Maximum single log capacity (byte)
|
numIoThreads |
Integer | Optional | Number of threads used to process server requests
|
numNetworkThreads |
Integer | Optional | Number of threads used to receive requests from the server and send responses
|
numPartitions |
Integer | Optional | Number of log partitions by topic
|
authorizerClassName |
String | Optional | Full path of the class responsible for authorization
|
allowEveryoneIfNoAclFound |
Boolean | Optional | Allow all access when ACL is missing
|
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
|
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"
}