Change config group description

Prev Next

Available in VPC

Change the description of a config group.

Request

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

Method URI
POST /api/v1/configGroup/setKafkaConfigGroupMemo/{configGroupNo} (Korea Region)
POST /api/sgn-v1/configGroup/setKafkaConfigGroupMemo/{configGroupNo} (Singapore Region)
POST /api/jpn-v1/configGroup/setKafkaConfigGroupMemo/{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
description String Optional Config group description
  • 0-255 characters

Request example

The request example is as follows:

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

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 Boolean - Response result
  • true | null
    • true: succeeded
    • null: failed
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": true,
    "requestId": "60221c3d-****-****-****-2acde6fe6718"
}