Search Engine Cluster 노드 조회

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

설명

Search Engine Cluster의 데이터 노드 목록을 확인합니다.

요청

요청 URL

GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterNodeList/{service-group-instance-no} [KR]
GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/getClusterNodeList/{service-group-instance-no} [SGN]
GET https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/getClusterNodeList/{service-group-instance-no} [JPN]

요청 헤더

헤더명	설명
x-ncp-apigw-timestamp	- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타냄 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID 값과 Secret Key로 암호화한 서명 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	Request body content type을 application/json으로 지정 `Content-Type: application/json`

요청 파라미터

파라미터	타입	필수 여부	설명
serviceGroupInstanceNo	String	Y	노드 목록을 조회할 Cluster 번호

요청 예시

GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterNodeList/1484848
HOST: vpcsearchengine.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
x-ncp-apigw-timestamp: 1593848345548
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw

curl -X GET "https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterNodeList/1484848" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
-H "x-ncp-apigw-timestamp: 1601971222179" \
-H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4="

응답 파라미터

public class GetClusterNodeList {
    List<GetNodeListResponseDetailVo> computeList;
    Integer contractNo;
    DateTimeVo createdDate;
    String productCode;
    Integer regionNo;
    Integer serviceGroupInstanceNo;
    String serviceGroupInstanceTypeCode;
    String serviceGroupName;
    String statusCode;
    Integer vpcNo;
}

public class GetNodeListResponseDetailVo {
    Integer computeInstanceNo;
    String computeInstanceProductCode;
    String computeInstanceStatus;
    Integer cpuCount;
    DateTimeVo createdYmdt;
    String hostName;
    String macAddress;
    Long memorySize;
    String nodeRoleCode;
    DateTimeVo operationYmdt;
    String osInfo;
    String privateIp;
    String regionCode;
    String regionName;
    String regionNo;
    Boolean selfManaged;
    Integer serviceGroupInstanceNo;
    String uuid;
    String vpcName;
    Integer vpcNo;
    String subnetName;
    Integer subnetNo;
    String zoneName;
    Integer zoneNo;
}

public class DateTimeVo {
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd", timezone = "Asia/Seoul")
    Date formattedDate;
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss SSSSSS", timezone = "Asia/Seoul")
    Date formattedDateTime;
    Long utc;
}

필드

파라미터명	타입	설명
computeList	List<GetNodeListResponseDetailVo>	노드 목록
contractNo	Integer	계약 번호
createdDate	DateTimeVo	클러스터 생성 날짜
productCode	String	OS 상품 코드
regionNo	Integer	서버가 위치해있는 리전 번호
serviceGroupInstanceNo	Integer	Cluster 인스턴스 번호
serviceGroupInstanceTypeCode	String	Cluster 인스턴스 타입
serviceGroupName	String	Cluster 이름
statusCode	String	Instance 상태 코드
vpcNo	Integer	서버가 위치해있는 VPC 번호
computeInstanceNo	Integer	서버 인스턴스 번호
computeInstanceProductCode	String	서버 인스턴스 HW 상품 코드
computeInstanceStatus	String	서버 인스턴스 상태 코드
cpuCount	Integer	virtual CPU 개수
createdYmdt	DateTimeVo	서버 생성일자
hostName	String	서버 인스턴스 이름
macAddress	String	서버 인스턴스 맥 주소
memorySize	Long	Byte 형태의 메모리 사이즈
nodeRoleCode	String	서버 역할 코드
operationYmdt	DateTimeVo	서버 작동 시간
osInfo	String	OS 정보
privateIp	String	사설 IP 주소
regionCode	String	서버가 위치해 있는 리전 코드
regionName	String	서버가 위치해 있는 리전 이름
regionNo	String	서버가 위치해 있는 리전 번호
selfManaged	Boolean	콘솔 Server 탭 노출 여부
serviceGroupInstanceNo	Integer	Cluster 인스턴스 번호
uuid	String	서버 인스턴스 고유 식별자
vpcName	String	서버가 위치해 있는 VPC 이름
vpcNo	Integer	서버가 위치해 있는 VPC 번호
subnetName	String	서버가 위치해 있는 Subnet 이름
subnetNo	Integer	서버가 위치해 있는 Subnet 번호
zoneName	String	서버가 위치해 있는 Zone 이름
zoneNo	Integer	서버가 위치해 있는 Zone 번호
formattedDate	Date	생성된 날짜
formattedDateTime	Date	생성된 날짜 및 시간
utc	Long	생성된 UTC 시간을 millisecond로 변환

응답 예시

{
  "code": 0,
  "message": "SUCCESS",
  "result": {
    "contractNo": 505151,
    "createdDate": {
      "formattedDate": "2020-10-06",
      "formattedDateTime": "2020-10-06 18:06:40 000073",
      "utc": 1601975200073
    },
    "productCode": "SW.VELST.OS.LNX64.CNTOS.0703.B050",
    "regionNo": 1,
    "serviceGroupInstanceNo": 1484848,
    "serviceGroupInstanceTypeCode": "VELST",
    "serviceGroupName": "openapitest11",
    "statusCode": "CREAT",
    "vpcNo": 36752,
    "computeList": [
      {
        "computeInstanceNo": 1484849,
        "computeInstanceProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
        "computeInstanceStatus": "running",
        "cpuCount": 2,
        "createdYmdt": {
          "formattedDate": "2020-10-06",
          "formattedDateTime": "2020-10-06 18:06:40 000999",
          "utc": 1601975200999
        },
        "hostName": "openapitest11-m-9wy",
        "macAddress": "F2:20:EF:7A:A6:D3",
        "memorySize": 4294967296,
        "nodeRoleCode": "M",
        "operationYmdt": {
          "formattedDate": "2020-10-06",
          "formattedDateTime": "2020-10-06 18:09:41 000867",
          "utc": 1601975381867
        },
        "osInfo": "CentOS 7.3 (64-bit)",
        "privateIp": "10.0.1.14",
        "regionCode": "KR",
        "regionName": "Korea",
        "regionNo": "11",
        "selfManaged": false,
        "serviceGroupInstanceNo": 1484848,
        "uuid": "1db365ff-9ac8-d7fa-dcb3-437c2b9cf43a",
        "vpcName": "test",
        "vpcNo": 36752,
        "subnetNo": 22630,
        "subnetName": "testpri | KR-1 | Private",
        "zoneName": "KR-1",
        "zoneNo": 2
      },
      {
        "computeInstanceNo": 1484852,
        "computeInstanceProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
        "computeInstanceStatus": "running",
        "cpuCount": 2,
        "createdYmdt": {
          "formattedDate": "2020-10-06",
          "formattedDateTime": "2020-10-06 18:06:41 000175",
          "utc": 1601975201175
        },
        "hostName": "openapitest11-m-9wz",
        "macAddress": "F2:20:EF:13:02:04",
        "memorySize": 4294967296,
        "nodeRoleCode": "M",
        "operationYmdt": {
          "formattedDate": "2020-10-06",
          "formattedDateTime": "2020-10-06 18:09:44 000829",
          "utc": 1601975384829
        },
        "osInfo": "CentOS 7.3 (64-bit)",
        "privateIp": "10.0.1.15",
        "regionCode": "KR",
        "regionName": "Korea",
        "regionNo": "1",
        "selfManaged": false,
        "serviceGroupInstanceNo": 1484848,
        "uuid": "835f6c82-a4f4-c85a-21fe-f7b86a6b33e0",
        "vpcName": "test",
        "vpcNo": 36752,
        "subnetNo": 22630,
        "subnetName": "testpri | KR-1 | Private",
        "zoneName": "KR-1",
        "zoneNo": 2
      },
      {
        "computeInstanceNo": 1484855,
        "computeInstanceProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
        "computeInstanceStatus": "running",
        "cpuCount": 2,
        "createdYmdt": {
          "formattedDate": "2020-10-06",
          "formattedDateTime": "2020-10-06 18:06:41 000384",
          "utc": 1601975201384
        },
        "hostName": "openapitest11-d-9x0",
        "macAddress": "F2:20:EF:F9:6A:6D",
        "memorySize": 4294967296,
        "nodeRoleCode": "D",
        "operationYmdt": {
          "formattedDate": "2020-10-06",
          "formattedDateTime": "2020-10-06 18:09:49 000782",
          "utc": 1601975389782
        },
        "osInfo": "CentOS 7.3 (64-bit)",
        "privateIp": "10.0.1.16",
        "regionCode": "KR",
        "regionName": "Korea",
        "regionNo": "1",
        "selfManaged": false,
        "serviceGroupInstanceNo": 1484848,
        "uuid": "50551c12-d482-6401-f120-b2175a329a19",
        "vpcName": "test",
        "vpcNo": 36752,
        "subnetNo": 22630,
        "subnetName": "testpri | KR-1 | Private",
        "zoneName": "KR-1",
        "zoneNo": 2
      },
      {
        "computeInstanceNo": 1484859,
        "computeInstanceProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
        "computeInstanceStatus": "running",
        "cpuCount": 2,
        "createdYmdt": {
          "formattedDate": "2020-10-06",
          "formattedDateTime": "2020-10-06 18:06:41 000563",
          "utc": 1601975201563
        },
        "hostName": "openapitest11-d-9x1",
        "macAddress": "F2:20:EF:17:1C:F6",
        "memorySize": 4294967296,
        "nodeRoleCode": "D",
        "operationYmdt": {
          "formattedDate": "2020-10-06",
          "formattedDateTime": "2020-10-06 18:09:51 000143",
          "utc": 1601975391143
        },
        "osInfo": "CentOS 7.3 (64-bit)",
        "privateIp": "10.0.1.17",
        "regionCode": "KR",
        "regionName": "Korea",
        "regionNo": "1",
        "selfManaged": false,
        "serviceGroupInstanceNo": 1484848,
        "uuid": "f5633747-b6b1-5452-ddda-940c99b0c9c8",
        "vpcName": "test",
        "vpcNo": 36752,
        "subnetNo": 22630,
        "subnetName": "testpri | KR-1 | Private",
        "zoneName": "KR-1",
        "zoneNo": 2
      },
      {
        "computeInstanceNo": 1484863,
        "computeInstanceProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
        "computeInstanceStatus": "running",
        "cpuCount": 2,
        "createdYmdt": {
          "formattedDate": "2020-10-06",
          "formattedDateTime": "2020-10-06 18:06:41 000737",
          "utc": 1601975201737
        },
        "hostName": "openapitest11-d-9x2",
        "macAddress": "F2:20:EF:03:FA:5E",
        "memorySize": 4294967296,
        "nodeRoleCode": "D",
        "operationYmdt": {
          "formattedDate": "2020-10-06",
          "formattedDateTime": "2020-10-06 18:09:46 000197",
          "utc": 1601975386197
        },
        "osInfo": "CentOS 7.3 (64-bit)",
        "privateIp": "10.0.1.18",
        "regionCode": "KR",
        "regionName": "Korea",
        "regionNo": "1",
        "selfManaged": false,
        "serviceGroupInstanceNo": 1484848,
        "uuid": "1e6d6df9-f140-2a9f-b0cf-74479807ff26",
        "vpcName": "test",
        "vpcNo": 36752,
        "subnetNo": 22630,
        "subnetName": "testpri | KR-1 | Private",
        "zoneName": "KR-1",
        "zoneNo": 2
      }
    ]
  },
  "requestId": "985024f0-4e51-4105-a555-d9f62d43fede"
}

이 문서가 도움이 되었습니까?

What's Next

Search Engine Cluster ACG 조회

설명
요청
응답 파라미터
필드

태그

Search Engine Service