Get config group

Available in VPC

Get details of a config group.

Request

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

Method	URI
POST	/api/v1/configGroup/getKafkaConfigGroup/{configGroupNo} (Korea Region)
POST	/api/sgn-v1/configGroup/getKafkaConfigGroup/{configGroupNo} (Singapore Region)
POST	/api/jpn-v1/configGroup/getKafkaConfigGroup/{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.

Request example

The request example is as follows:

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaConfigGroup/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.configGroupNo`	Integer	-	Config group number
`result.memberNo`	String	-	User's NAVER Cloud Platform member ID
`result.configGroupName`	String	-	Config group name
`result.kafkaVersionCode`	String	-	Kafka version code
`result.description`	String	-	Description of config group
`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**,
        "memberNo": "500****",
        "configGroupName": "cg1",
        "kafkaVersionCode": "3903006",
        "description": "config group 1"
    },
    "requestId": "cf182753-****-****-****-68f64cadf730"
}