클러스터 목록 조회

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

Search Engine 클러스터 목록을 조회합니다.

요청

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

메서드	URI
GET	/api/v2/cluster/getClusterInfoList (수도권)
GET	/api/krs-v2/cluster/getClusterInfoList (남부권)

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`inputText`	String	Optional	검색 키워드 클러스터 이름이 전체 또는 부분 일치하는 값 필터링
`vpcName`	String	Optional	VPC 이름 전체 일치하는 값만 필터링
`pageNo`	Integer	Optional	페이지 번호 1~N (기본값: 1)
`pageSize`	Integer	Optional	페이지 출력 수 1~N (기본값: 10)

요청 예시

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

curl --location --request GET 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/getClusterInfoList?pageNo=1&pageSize=20&inputText=cluster&vpcName=myvpc' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`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.allowedClusters`	Array	-	클러스터 목록
`result.disallowedClusters`	Array	-	권한 없는 클러스터 목록 서브 계정으로 호출 시 getClusterDetail 권한이 적용되지 않은 클러스터 표시
`requestId`	String	-	요청에 대한 아이디 UUID 형식

`result.allowedClusters`

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

필드	타입	필수 여부	설명
`clusterName`	String	-	클러스터 이름
`dataNodeType`	String	-	데이터 노드 타입
`dataNodeProductName`	String	-	데이터 노드 서버 타입 이름
`dataNodeCount`	Integer	-	데이터 노드 수
`clusterStatus`	String	-	클러스터 상태
`searchEngineStatus`	String	-	Search Engine 상태
`searchEngineVersion`	String	-	Search Engine 버전
`softwareProductName`	String	-	운영 체제 버전
`createDate`	String	-	클러스터 생성 일시
`managerNodeType`	String	-	매니저 노드 타입
`managerNodeCount`	Integer	-	매니저 노드 수
`dataStorageVolumeSize`	Integer	-	데이터 노드 스토리지 용량
`managerNodeAccessControlGroupSequence`	Integer	-	매니저 노드 ACG 아이디
`managerNodeAccessControlGroupName`	String	-	매니저 노드 ACG 이름
`dataNodeAccessControlGroupSequence`	Integer	-	데이터 노드 ACG 아이디
`dataNodeAccessControlGroupName`	String	-	데이터 노드 ACG 이름
`searchEnginePort`	String	-	Search Engine 포트 번호
`searchEngineDashboardPort`	String	-	대시보드 포트 번호
`loginKeyName`	String	-	인증키 이름
`serviceGroupInstanceNo`	String	-	클러스터 인스턴스 번호
`searchEngineUserName`	String	-	Search Engine 접근 아이디
`memberNo`	String	-	사용자의 네이버 클라우드 플랫폼 회원 번호
`vpcName`	String	-	VPC 이름
`vpcNo`	Integer	-	VPC 번호
`managerNodeSubnetName`	String	-	매니저 노드 Subnet 이름
`managerNodeSubnetNo`	Integer	-	매니저 노드 Subnet 번호
`dataNodeSubnetName`	String	-	데이터 노드 Subnet 이름
`dataNodeSubnetNo`	Integer	-	데이터 노드 Subnet 번호
`isPluginInstalled`	Boolean	-	Object Storage 플러그인(S3 repository) 설치 여부 `true` (기본값) \| `false` `true`: 설치 `false`: 설치 안 됨
`isDualManager`	Boolean	-	매니저 노드 이중화 여부 `true` \| `false` `true`: 이중화 `false`: 이중화 안 함
`accessKeyId`	String	-	Object Storage 접근용 API 인증키 클러스터 스냅샷 생성을 위해 Object Storage 접근 API 인증키를 설정한 경우에 표시 API 인증키 설정 방법: Search Engine Service 사용 가이드 참조
`isMasterOnlyNodeActivated`	Boolean	-	마스터 노드 활성화 여부 `true` \| `false` `true`: 활성화 `false`: 비활성화
`masterNodeAccessControlGroupSequence`	Integer	-	마스터 노드 ACG 아이디
`masterNodeAccessControlGroupName`	String	-	마스터 노드 ACG 이름
`masterNodeSubnetName`	String	-	마스터 노드 Subnet 이름
`masterNodeSubnetNo`	Integer	-	마스터 노드 Subnet 번호
`masterNodeType`	String	-	마스터 노드 타입
`masterNodeProductName`	String	-	마스터 노드 서버 타입 이름
`masterNodeCount`	Integer	-	마스터 노드 수

`result.disallowedClusters`

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

필드	타입	필수 여부	설명
`clusterName`	String	-	클러스터 이름
`clusterStatus`	String	-	클러스터 상태
`searchEngineStatus`	String	-	Search Engine 상태
`serviceGroupInstanceNo`	String	-	클러스터 인스턴스 번호

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 20,
        "totalCount": 5,
        "totalPage": 1,
        "allowedClusters": [
            {
                "clusterName": "cluster000",
                "dataNodeType": "[STAND] 2vCPU, 8GB Mem",
                "dataNodeProductName": "vCPU 2개, 메모리 8GB, [SSD]디스크 50GB",
                "dataNodeCount": 3,
                "clusterStatus": "running",
                "searchEngineStatus": "green",
                "searchEngineVersion": "OpenSearch 2.14.0",
                "softwareProductName": "CentOS 7.8 (64-bit)",
                "createDate": "2025-03-20 11:31:48",
                "managerNodeType": "[STAND] 2vCPU, 8GB Mem",
                "managerNodeCount": 2,
                "dataStorageVolumeSize": 322122547200,
                "managerNodeAccessControlGroupSequence": 249484,
                "managerNodeAccessControlGroupName": "searchengine-m-1pr1dg",
                "dataNodeAccessControlGroupSequence": 249483,
                "dataNodeAccessControlGroupName": "searchengine-do-1pr1dg",
                "searchEnginePort": "9200",
                "searchEngineDashboardPort": "5601",
                "loginKeyName": "loginkey01",
                "serviceGroupInstanceNo": "1037*****",
                "searchEngineUserName": "userid",
                "memberNo": "279****",
                "vpcName": "myvpc",
                "vpcNo": 9****,
                "managerNodeSubnetName": "s1-hd-pri | KR-2 | Private",
                "managerNodeSubnetNo": 20****,
                "dataNodeSubnetName": "s1-hd-pri | KR-2 | Private",
                "dataNodeSubnetNo": 20****,
                "isPluginInstalled": true,
                "isDualManager": true,
                "accessKeyId": "******************",
                "isMasterOnlyNodeActivated": true,
                "masterNodeAccessControlGroupSequence": 249485,
                "masterNodeAccessControlGroupName": "searchengine-mo-1pr1dg",
                "masterNodeSubnetName": "s1-hd-pri | KR-2 | Private",
                "masterNodeSubnetNo": 20****,
                "masterNodeType": "[STAND] 2vCPU, 8GB Mem",
                "masterNodeProductName": "vCPU 2개, 메모리 8GB, [SSD]디스크 50GB",
                "masterNodeCount": 3
            },
            ...
        ],
        "disallowedClusters": [
            {
                "clusterName": "cluster007",
                "clusterStatus": "running",
                "searchEngineStatus": "green",
                "serviceGroupInstanceNo": "1037*****"
            },
            ...
        ]
    },
    "requestId": "ecc71c59-****-****-****-a46b472f04c4"
}