MENU
      Search Engine Monitoring 데이터 조회

        Search Engine Monitoring 데이터 조회


        기사 요약

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

        설명

        Cluster 또는 서버의 Search Engine Monitoring 데이터를 조회합니다.

        요청

        요청 URL

        GET https://vpcsearchengine.apigw.ntruss.com/api/v2/monitoring/getSearchEngineMonitoringData/{service-group-instance-no}
        ?computeInstanceNo={computeInstanceNo}
        &interval={interval}
        &metric={metric}
        &timeEnd={timeEnd}
        &timeStart={timeStart} [KR]
        
        GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/monitoring/getSearchEngineMonitoringData/{service-group-instance-no}
        ?computeInstanceNo={computeInstanceNo}
        &interval={interval}
        &metric={metric}
        &timeEnd={timeEnd}
        &timeStart={timeStart} [SGN]
        
        GET https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/monitoring/getSearchEngineMonitoringData/{service-group-instance-no}
        ?computeInstanceNo={computeInstanceNo}
        &interval={interval}
        &metric={metric}
        &timeEnd={timeEnd}
        &timeStart={timeStart} [JPN]
        HTTP

        요청 헤더

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

        요청 파라미터

        파라미터타입필수 여부설명
        serviceGroupInstanceNoStringY조회할 Cluster의 번호
        timeStartLongY조회 시작 시간(Millisecond)
        timeEndLongY조회 종료 시간(Millisecond)
        metricStringY조회하려는 metric 명
        computeInstanceNoStringY조회할 서버의 Compute Instance No(Cluster Metric 조회 시 매니저 서버의 Compute Instance No)
        intervalStringN집계 주기(default: Min1)
        • Search Engine Metric(Cluster)
        MetricDescription
        CLUSTER_ALL_METRICS클러스터의 모든 Metric
        • Elasticsearch Metric(서버)
        MetricDescription
        SES_ALL_METRICSSearch Engine의 모든 Metric
        • Interval
        MetricDescription
        Min11분 간격으로 조회(최대 1일)
        Min55분 간격으로 조회(최대 1주일)
        Min3030분 간격으로 조회(최대 1개월)
        Hour22시간 간격으로 조회(최대 3개월)
        Day11일 간격으로 조회(최대 1년)

        요청 예시

        GET https://vpcsearchengine.apigw.ntruss.com/api/v2/monitoring/getSearchEngineMonitoringData/1768175
        ?computeInstanceNo=2416997
        &metric=ES_ALL_METRICS
        &timeEnd=1657590447000
        &timeStart=1657586847000
        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
        HTTP
        curl -X GET "https://vpcsearchengine.apigw.ntruss.com/api/v2/monitoring/getSearchEngineMonitoringData/1768175
        ?computeInstanceNo=2416997
        &metric=ES_ALL_METRICS
        &timeEnd=1657590447000
        &timeStart=1657586847000 \
        -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=" \
        Bash

        응답 파라미터

        public class QueryDataResponseVo {
            List<MetricInfoResponseVo> data;
        }
        
        public class MetricInfoResponseVo{
            List<ArrayList<Object>> dps;
            String aggregation;
            DimensionsVo dimensions;
            String interval;
            String metric;
            String graphName;
            String productName;
        }
        
        public class DimensionsVo {
             @JsonProperty("Svc_group_instance_no")
             String serviceGroupInstanceNo;
             String instanceNo;
        }
        Java

        필드

        파라미터명타입설명
        dataListMonitoring 데이터 정보
        dpsList<ArrayList>모니터링 정보(timestamp, data 형태)
        aggregationString조회하는 데이터의 집계함수
        dimensionsDimensionsVo조회하는 데이터의 구분자
        intervalString조회하는 데이터의 집계주기
        metricString조회하는 Metric 명
        graphNameString그래프 이름
        productNameString상품 이름
        serviceGroupInstanceNoString조회하는 Cluster의 Service Group Instance No
        instanceNoString조회하는 서버의 Compute Instance No

        응답 예시

        {
          "code": 0,
          "message": "SUCCESS",
          "result": {
            "data": [
              {
                "dps": [
                  [
                    1626315360000,
                    0
                  ],
                  [
                    1626315420000,
                    0
                  ]
                ],
                "aggregation": "AVG",
                "dimensions": {
                  "instanceNo": "1768176",
                  "Svc_group_instance_no": "1768175"
                },
                "interval": "Min1",
                "metric": "Indexing Rate",
                "graphName": "Indexing Rate(/m)",
                "productName": "Search Engine Service(VPC)"
              },
              {
                "dps": [
                  [
                    1626315360000,
                    0
                  ],
                  [
                    1626315420000,
                    0
                  ]
                ],
                "aggregation": "AVG",
                "dimensions": {
                  "instanceNo": "1768176",
                  "Svc_group_instance_no": "1768175"
                },
                "interval": "Min1",
                "metric": "Search Rate",
                "graphName": "Search Rate(/m)",
                "productName": "Search Engine Service(VPC)"
              },
              {
                "dps": [
                  [
                    1626315360000,
                    0
                  ],
                  [
                    1626315420000,
                    0
                  ]
                ],
                "aggregation": "AVG",
                "dimensions": {
                  "instanceNo": "1768176",
                  "Svc_group_instance_no": "1768175"
                },
                "interval": "Min1",
                "metric": "Indexing Latency",
                "graphName": "Indexing Latency(/ms)",
                "productName": "Search Engine Service(VPC)"
              },
              {
                "dps": [
                  [
                    1626315360000,
                    0
                  ],
                  [
                    1626315420000,
                    0
                  ]
                ],
                "aggregation": "AVG",
                "dimensions": {
                  "instanceNo": "1768176",
                  "Svc_group_instance_no": "1768175"
                },
                "interval": "Min1",
                "metric": "Search Latency",
                "graphName": "Search Latency(/ms)",
                "productName": "Search Engine Service(VPC)"
              },
              {
                "dps": [
                  [
                    1626315360000,
                    5
                  ],
                  [
                    1626315420000,
                    5
                  ],
                  [
                    1626315480000,
                    5
                  ]
                ],
                "aggregation": "AVG",
                "dimensions": {
                  "instanceNo": "1768176",
                  "Svc_group_instance_no": "1768175"
                },
                "interval": "Min1",
                "metric": "Node Count",
                "graphName": "Node Count",
                "productName": "Search Engine Service(VPC)"
              },
              {
                "dps": [
                  [
                    1626315360000,
                    1
                  ],
                  [
                    1626315420000,
                    1
                  ],
                  [
                    1626315480000,
                    1
                  ]
                ],
                "aggregation": "AVG",
                "dimensions": {
                  "instanceNo": "1768176",
                  "Svc_group_instance_no": "1768175"
                },
                "interval": "Min1",
                "metric": "Documents Total",
                "graphName": "Documents Total",
                "productName": "Search Engine Service(VPC)"
              },
              {
                "dps": [
                  [
                    1626315360000,
                    11
                  ],
                  [
                    1626315420000,
                    11
                  ],
                  [
                    1626315480000,
                    11
                  ]
                ],
                "aggregation": "AVG",
                "dimensions": {
                  "instanceNo": "1768176",
                  "Svc_group_instance_no": "1768175"
                },
                "interval": "Min1",
                "metric": "Indices Total",
                "graphName": "Indices Total",
                "productName": "Search Engine Service(VPC)"
              },
              {
                "dps": [
                  [
                    1626315360000,
                    22
                  ],
                  [
                    1626315420000,
                    22
                  ],
                  [
                    1626315480000,
                    22
                  ]
                ],
                "aggregation": "AVG",
                "dimensions": {
                  "instanceNo": "1768176",
                  "Svc_group_instance_no": "1768175"
                },
                "interval": "Min1",
                "metric": "Shards Total",
                "graphName": "Shards Total",
                "productName": "Search Engine Service(VPC)"
              },
              {
                "dps": [
                  [
                    1626315360000,
                    0
                  ],
                  [
                    1626315420000,
                    0
                  ],
                  [
                    1626315480000,
                    0
                  ]
                ],
                "aggregation": "AVG",
                "dimensions": {
                  "instanceNo": "1768176",
                  "Svc_group_instance_no": "1768175"
                },
                "interval": "Min1",
                "metric": "Disk Used",
                "graphName": "Disk Used(GB)",
                "productName": "Search Engine Service(VPC)"
              }
            ]
          },
          "requestId": "418fc34b-0eb2-4e4e-b670-37c08aea3ed9"
        }
        JSON

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

        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.