Config Group 적용 클러스터 조회

VPC 환경에서 이용 가능합니다.

Config Group을 적용 중인 Cloud Data Streaming Service 클러스터 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/api/v1/configGroup/getConfigGroupUsingClusterList/{configGroupNo} (수도권)
POST	/api/krs-v1/configGroup/getConfigGroupUsingClusterList/{configGroupNo} (남부권)

요청 헤더

Cloud Data Streaming Service API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Data Streaming Service 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`configGroupNo`	Integer	Required	Config Group 번호 Config Group 목록 조회 참조

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`pageNo`	Integer	Optional	페이지 번호 1~N (기본값: 1)
`pageSize`	Integer	Optional	페이지당 항목 수 1~N (기본값: 10)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/configGroup/getConfigGroupUsingClusterList/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 '{
  "pageNo": 1,
  "pageSize": 10
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`code`	Integer	-	응답 코드
`message`	String	-	응답 메시지
`result`	Object	-	응답 결과
`result.currentPage`	Integer	-	현재 페이지 번호
`result.isFirst`	Boolean	-	첫 페이지 여부 `true` \| `false` `true`: 첫 페이지 `false`: 첫 페이지 아님
`result.isLast`	Boolean	-	마지막 페이지 여부 `true` \| `false` `true`: 마지막 페이지 `false`: 마지막 페이지 아님
`result.pageSize`	Integer	-	페이지 출력 수
`result.totalCount`	Integer	-	응답 결과 수
`result.totalPage`	Integer	-	전체 페이지 수
`result.usingClusterNameList`	Array	-	적용 클러스터 목록
`requestId`	String	-	요청에 대한 아이디 UUID 형식

`usingClusterNameList`

usingClusterNameList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`clusterName`	String	-	클러스터 이름
`serviceGroupInstanceNo`	Integer	-	클러스터 인스턴스 번호

응답 상태 코드

Cloud Data Streaming Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Data Streaming Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 10,
        "totalCount": 1,
        "totalPage": 1,
        "usingClusterNameList": [
            {
                "clusterName": "cluster00",
                "serviceGroupInstanceNo": 10091****
            }
        ]
    },
    "requestId": "fdd91ab0-****-****-****-adc9527a0b8b"
}