노드 목록 조회

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

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

요청

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

메서드	URI
GET	/api/v2/cluster/getClusterNodeList/{serviceGroupInstanceNo} (수도권)
GET	/api/krs-v2/cluster/getClusterNodeList/{serviceGroupInstanceNo} (남부권)

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`serviceGroupInstanceNo`	Integer	Required	클러스터 인스턴스 번호 클러스터 목록 조회 참조

요청 예시

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

curl --location --request GET 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/getClusterNodeList/1037*****' \
--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.contractNo`	Integer	-	계약 번호
`result.createdDate`	Object	-	클러스터 생성 일시
`result.createdDate.formattedDate`	String	-	클러스터 생성 일자 yyyy-MM-dd 형식
`result.createdDate.formattedDateTime`	String	-	클러스터 생성 일시 yyyy-MM-dd HH:mm:ss SSSSSS 형식
`result.createdDate.utc`	Integer	-	클러스터 생성 일시(밀리초) Unix Timestamp 형식
`result.productCode`	String	-	운영체제 상품 코드
`result.regionNo`	Integer	-	리전 번호
`result.serviceGroupInstanceNo`	Integer	-	클러스터 인스턴스 번호
`result.serviceGroupInstanceTypeCode`	String	-	클러스터 인스턴스 타입
`result.serviceGroupName`	String	-	클러스터 이름
`result.statusCode`	String	-	클러스터 상태
`result.vpcNo`	Integer	-	VPC 번호
`result.computeList`	Array	-	노드 목록
`requestId`	String	-	요청에 대한 아이디 UUID 형식

`result.computeList`

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

필드	타입	필수 여부	설명
`computeInstanceNo`	Integer	-	노드 서버 인스턴스 번호
`computeInstanceProductCode`	String	-	노드 서버 타입 코드
`computeInstanceStatus`	String	-	노드 서버 상태
`cpuCount`	Integer	-	CPU 수
`createdYmdt`	Object	-	노드 생성 일시
`createdYmdt.formattedDate`	String	-	노드 생성 일자 yyyy-MM-dd 형식
`createdYmdt.formattedDateTime`	String	-	노드 생성 일시 yyyy-MM-dd HH:mm:ss SSSSSS 형식
`createdYmdt.utc`	Integer	-	노드 생성 일시(밀리초) Unix Timestamp 형식
`hostName`	String	-	노드 서버 이름
`macAddress`	String	-	노드 서버 MAC 주소
`memorySize`	Integer	-	노드 서버 메모리 크기(Byte)
`nodeRoleCode`	String	-	노드 타입 코드 `M` \| `D` \| `DO` \| `MO` `M`: 매니저 노드 `D`, `DO`: 데이터 노드 `MO`: 마스터 노드
`operationYmdt`	Object	-	서버 작동 일시
`operationYmdt.formattedDate`	String	-	서버 작동 일자 yyyy-MM-dd 형식
`operationYmdt.formattedDateTime`	String	-	서버 작동 일시 yyyy-MM-dd HH:mm:ss SSSSSS 형식
`operationYmdt.utc`	Integer	-	서버 작동 일시(밀리초) Unix Timestamp 형식
`osInfo`	String	-	운영 체제 버전
`privateIp`	String	-	노드 서버 내부 IP
`regionCode`	String	-	리전 코드
`regionName`	String	-	리전 이름
`regionNo`	String	-	리전 번호
`serviceGroupInstanceNo`	Integer	-	클러스터 인스턴스 번호
`uuid`	String	-	노드 서버 아이디 UUID 형식
`vpcName`	String	-	VPC 이름
`vpcNo`	Integer	-	VPC 번호
`subnetNo`	Integer	-	Subnet 번호
`subnetName`	String	-	Subnet 이름
`zoneName`	String	-	존 이름
`zoneNo`	Integer	-	존 번호

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "contractNo": 19146995,
        "createdDate": {
            "formattedDate": "2025-03-20",
            "formattedDateTime": "2025-03-20 17:04:37 000283",
            "utc": 1742457877283
        },
        "productCode": "SW.VELST.OS.LNX64.ROCKY.0808.B050",
        "regionNo": 1,
        "serviceGroupInstanceNo": 1037*****,
        "serviceGroupInstanceTypeCode": "ELASTICSEARCH",
        "serviceGroupName": "cluster006",
        "statusCode": "CREAT",
        "vpcNo": 9****,
        "computeList": [
            {
                "computeInstanceNo": 1037*****,
                "computeInstanceProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
                "computeInstanceStatus": "running",
                "cpuCount": 2,
                "createdYmdt": {
                    "formattedDate": "2025-03-20",
                    "formattedDateTime": "2025-03-20 17:04:38 000446",
                    "utc": 1742457878446
                },
                "hostName": "cluster006-m-6tvf",
                "macAddress": "F2:**:**:**:**:40",
                "memorySize": 8589934592,
                "nodeRoleCode": "M",
                "operationYmdt": {
                    "formattedDate": "2025-03-20",
                    "formattedDateTime": "2025-03-20 17:09:06 000267",
                    "utc": 1742458146267
                },
                "osInfo": "Rocky Linux 8.8",
                "privateIp": "**.**.**.**",
                "regionCode": "KR",
                "regionName": "Korea",
                "regionNo": "1",
                "serviceGroupInstanceNo": 1037*****,
                "uuid": "11b1a5d8-****-****-****-13647592550e",
                "vpcName": "myvpc",
                "vpcNo": 9****,
                "subnetNo": 20****,
                "subnetName": "s1-hd-pri | KR-2 | Private",
                "zoneName": "KR-2",
                "zoneNo": 3
            },
            ...
        ]
    },
    "requestId": "bb3354b1-****-****-****-5bee2500c24f"
}