View list of ConfigGroup for each Kafka version
- Print
- PDF
View list of ConfigGroup for each Kafka version
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Available in VPC
Description
View available ConfigGroup information depending on the Kafka version of the Cloud Data Streaming Service.
Requests
Request URL
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaVersionConfigGroupList [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/configGroup/getKafkaVersionConfigGroupList [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/configGroup/getKafkaVersionConfigGroupList [JPN]
Request Headers
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | - Time elapsed in milliseconds 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 | Access key ID issued on NAVER Cloud Platformx-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 | Set the request body content type to application/jsonContent-Type: application/json |
Request parameters
| Parameters | Type | Requirement status | Description |
|---|---|---|---|
| kafkaVersionCode | String | Y | - Cloud Data Streaming Service version being used - It can be acquired through the getCDSSVersion action |
| pageNo | Integer | N | Page number to be displayed (default: 1) |
| pageSize | Integer | N | Page size to be displayed (default: 10) |
Request examples
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaVersionConfigGroupList
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",
"pageNo": 1,
"pageSize": 10
}
curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getKafkaVersionConfigGroupList" \
-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",
"pageNo": 1,
"pageSize": 10
}'
Response parameter
public class GetKafkaConfigGroupListResponseVo {
private Integer currentPage;
private Boolean isFirst;
private Boolean isLast;
private Integer pageSize;
private Long totalCount;
private Integer totalPage;
private List<KafkaConfigGroup> KafkaConfigGroupList;
}
public class KafkaConfigGroup {
private String kafkaVersionCode;
private String kafkaVersion;
private Integer configGroupNo;
private String configGroupName;
private String description;
}
Field
| Parameter name | Type | Description |
|---|---|---|
| currentPage | Integer | Current page number |
| isFirst | Boolean | Indicates whether this is the first page |
| isLast | Boolean | Indicates whether this is the last page |
| pageSize | Integer | Number of data displayed on the page |
| totalCount | Long | Total number of data searched |
| totalPage | Integer | Number of all pages (totalCount/pageSize) |
| kafkaConfigGroupList | List<KafkaConfigGroup> | List of ConfigGroup |
| kafkaVersionCode | String | - Cloud Data Streaming Service version - It can be acquired through the getCDSSVersion action |
| kafkaVersion | String | Kafka version actually used in a cluster |
| configGroupNo | Integer | ConfigGroup number |
| configGroupName | String | ConfigGroup name |
| description | String | User description of ConfigGroup |
Response examples (success)
{
"code": 0,
"message": "SUCCESS",
"result": {
"currentPage": 1,
"isFirst": true,
"isLast": true,
"pageSize": 10,
"totalCount": 2,
"totalPage": 1,
"kafkaConfigGroupList": [
{
"kafkaVersionCode": "2403005",
"kafkaVersion": "2.4.0",
"configGroupNo": 174,
"configGroupName": "config-test",
"description": "actual test"
},
{
"kafkaVersionCode": "2403005",
"kafkaVersion": "2.4.0",
"configGroupNo": 236,
"configGroupName": "ttttetetet",
"description": "Description edit added "
}
]
},
"requestId": "e1b45201-d865-416d-af16-a7dea176a727"
}
Was this article helpful?