View Config Group information
- Print
- PDF
View Config Group information
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It is available in a VPC environment.
Description
Views the information of a Cloud Data Streaming Service config group.
Request
Request URL
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getKafkaConfigGroup/{configGroupNo} [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getKafkaConfigGroup/{configGroupNo} [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getKafkaConfigGroup/{configGroupNo} [JPN]
Request header
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | Value of access key ID issued on the NAVER Cloud Platform portalx-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v2 | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Specifies the request body content type as application/jsonContent-Type: application/json |
Request parameter
| Parameter | Type | Requirement status | Description |
|---|---|---|---|
| configGroupNo | String | Y | - ConfigGroupNo Number of the target ConfigGroup |
| kafkaVersionCode | String | Y | - Cloud Data Streaming Service version to be used It can be acquired through the getCDSSVersion action. |
Request examples
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getKafkaConfigGroup/236
HOST: clouddatastreamingservice.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: uLWYAZULzt3UZl5MeUo5Xj1mepW49qSMKc9n2rMv/YA=
x-ncp-apigw-timestamp: 1653981745173
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
{
"kafkaVersionCode": "2403005"
}
curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getKafkaConfigGroup/236" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2" \
-H "x-ncp-apigw-timestamp: 1653981745173" \
-H "x-ncp-apigw-signature-v2: uLWYAZULzt3UZl5MeUo5Xj1mepW49qSMKc9n2rMv/YA=" \
-d \
'{
"kafkaVersionCode" : "2403005"
}'
Response parameter
public class GetKafkaConfigGroupResponseVo{
private Integer configGroupNo;
private String memberNo;
private String configGroupName;
private String kafkaVersionCode;
private String description;
}
Field
| Parameter name | Type | Description |
|---|---|---|
| configGroupNo | Integer | ConfigGroup number |
| memberNo | String | Member number |
| configGroupName | String | ConfigGroup name |
| kafkaVersionCode | String | Kafka version code that can be used in ConfigGroup |
| description | String | User description |
Response examples (success)
{
"code": 0,
"message": "SUCCESS",
"result": {
"configGroupNo": 236,
"memberNo": "46",
"configGroupName": "configgroup-1",
"kafkaVersionCode": "2403005",
"description": "Config group 1"
},
"requestId": "b3dcf8e3-4111-4ac4-92e1-b80280fb160d"
}
Was this article helpful?