View list of clusters that are using the ConfigGroup
- Print
- PDF
View list of clusters that are using the ConfigGroup
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Available in VPC
Description
Views the list of clusters that using the Cloud Data Streaming Service ConfigGroup.
Requests
Request URL
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getConfigGroupUsingClusterList/{configGroupNo} [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/configGroup/getConfigGroupUsingClusterList/{configGroupNo} [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/configGroup/getConfigGroupUsingClusterList/{configGroupNo} [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 |
|---|---|---|---|
| configGroupNo | String | Y | - ConfigGroupNo - Target ConfigGroup number |
| pageNo | Integer | Y | Page number to be displayed (default: 1) |
| pageSize | Integer | Y | Page size to be displayed (default: 10) |
Request examples
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getConfigGroupUsingClusterList/174
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
{
"pageNo": 1,
"pageSize": 10
}
curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/configGroup/getConfigGroupUsingClusterList/174" \
-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 \
'{
"pageNo": 1,
"pageSize": 10
}'
Response parameter
public class GetConfigGroupUsingClusterListResponseVo {
private Integer currentPage;
private Boolean isFirst;
private Boolean isLast;
private Integer pageSize;
private Long totalCount;
private Integer totalPage;
private List<usingClusterNameList> ConfigGroupClusterInfo;
}
public class usingClusterNameList {
private String clusterName;
private Integer serviceGroupInstanceNo;
}
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<usingClusterNameList> | List of cluster that are using ConfigGroup |
| serviceGroupInstanceNo | Integer | Cluster instance number |
| clusterName | String | Cluster name |
Response examples (success)
{
"code": 0,
"message": "SUCCESS",
"result": {
"currentPage": 1,
"isFirst": true,
"isLast": true,
"pageSize": 10,
"totalCount": 2,
"totalPage": 1,
"usingClusterNameList": [
{
"clusterName": "cluster-sample1",
"serviceGroupInstanceNo": 2389832
},
{
"clusterName": "cluster-sample2",
"serviceGroupInstanceNo": 2389848
}
]
},
"requestId": "86f64c9b-053a-4069-94c9-644ece14b506"
}
Was this article helpful?