Search Engine Cluster Data 노드 조회
    • PDF

    Search Engine Cluster Data 노드 조회

    • PDF

    기사 요약

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

    설명

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

    요청

    요청 URL

    GET https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/getClusterNodeList/{service-group-instance-no} [수도권]
    GET https://vpcsearchengine.apigw.gov-ntruss.com/api/krs-v2/cluster/getClusterNodeList/{service-group-instance-no} [남부권]
    

    요청 헤더

    헤더명설명
    x-ncp-apigw-timestamp1970년 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-v2Access Key ID 값과 Secret Key로 암호화한 서명
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeRequest body content type을 application/json으로 지정
    Content-Type: application/json

    요청 파라미터

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

    요청 예시

    GET https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/getClusterNodeList/1484848
    HOST: vpcsearchengine.apigw.gov-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.gov-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 GetClusterDataNodeList {
        List<GetDataNodeListResponseDetailVo> computeList;
        Integer contractNo;
        DateTimeVo createdDate;
        String productCode;
        Integer regionNo;
        Integer serviceGroupInstanceNo;
        String serviceGroupInstanceTypeCode;
        String serviceGroupName;
        String statusCode;
        Integer vpcNo;
    }
    
    public class GetDataNodeListResponseDetailVo {
        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;
    }
    

    필드

    파라미터명타입설명
    computeListList<GetDataNodeListResponseDetailVo>데이터 노드 목록
    contractNoInteger계약 번호
    createdDateDateTimeVo클러스터 생성 날짜
    productCodeStringOS 상품 코드
    regionNoInteger서버가 위치해있는 리전 번호
    serviceGroupInstanceNoIntegerCluster 인스턴스 번호
    serviceGroupInstanceTypeCodeStringCluster 인스턴스 타입
    serviceGroupNameStringCluster 이름
    statusCodeStringInstance 상태 코드
    vpcNoInteger서버가 위치해있는 VPC 번호
    computeInstanceNoInteger서버 인스턴스 번호
    computeInstanceProductCodeString서버 인스턴스 HW 상품 코드
    computeInstanceStatusString서버 인스턴스 상태 코드
    cpuCountIntegervirtual CPU 개수
    createdYmdtDateTimeVo서버 생성일자
    hostNameString서버 인스턴스 이름
    macAddressString서버 인스턴스 맥 주소
    memorySizeLongByte 형태의 메모리 사이즈
    nodeRoleCodeString서버 역할 코드
    operationYmdtDateTimeVo서버 작동 시간
    osInfoStringOS 정보
    privateIpString사설 IP 주소
    regionCodeString서버가 위치해 있는 리전 코드
    regionNameString서버가 위치해 있는 리전 이름
    regionNoString서버가 위치해 있는 리전 번호
    selfManagedBoolean콘솔 Server 탭 노출 여부
    serviceGroupInstanceNoIntegerCluster 인스턴스 번호
    uuidString서버 인스턴스 고유 식별자
    vpcNameString서버가 위치해 있는 VPC 이름
    vpcNoInteger서버가 위치해 있는 VPC 번호
    subnetNameString서버가 위치해 있는 Subnet 이름
    subnetNoInteger서버가 위치해 있는 Subnet 번호
    zoneNameString서버가 위치해 있는 Zone 이름
    zoneNoInteger서버가 위치해 있는 Zone 번호
    formattedDateDate생성된 날짜
    formattedDateTimeDate생성된 날짜 및 시간
    utcLong생성된 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": "1",
            "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"
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.