Create config group

Prev Next

Available in VPC

Create a config group.

Request

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

Method URI
POST /api/v1/configGroup/createConfigGroup (Korea Region)
POST /api/sgn-v1/configGroup/createConfigGroup (Singapore Region)
POST /api/jpn-v1/configGroup/createConfigGroup (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 body

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

Field Type Required Description
configGroupName String Required Config group name
  • Enter 3 to 30 characters using a combination of lowercase English letters, numbers, and the special character "-".
  • The string must start with a lowercase English letter and end with a lowercase English letter or a number.
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/createConfigGroup' \
--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 '{
    "configGroupName": "my-configgroup1",
    "description": "my description 1",
    "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.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": 376
    },
    "requestId": "8445b2f8-****-****-****-2b6e468da2ed"
}