MENU
      View Search Engine monitoring data

        View Search Engine monitoring data


        Article summary

        Can be used in a VPC environment.

        Description

        View the Search Engine monitoring data for clusters or servers.

        Requests

        Request 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

        Request header

        HeaderDescription
        x-ncp-apigw-timestampNumber of milliseconds that have elapsed since January 1, 1970 00:00:00.
        If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyValue of Access Key ID issued on Naver Cloud Platform portal
        x-ncp-iam-access-key:{Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with the Access Key ID value and Secret Key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeSpecifies the request body content type as application/json
        Content-Type: application/json

        Request parameters

        ParameterTypeRequirement statusDescription
        serviceGroupInstanceNoStringYCluster number to be searched
        timeStartLongYSearch start time (milliseconds)
        timeEndLongYSearch end time (milliseconds)
        metricStringYMetric name to be searched
        computeInstanceNoStringYCompute instance number of the server to be searched (compute instance number of the manager server if searching cluster metric)
        intervalStringNAggregation interval (default: Min1)
        • Search Engine Metric(Cluster)
          When calling, one of the computeInstanceNo for the manager server must be entered for the computeInstanceNo.
        MetricDescription
        CLUSTER_ALL_METRICSAll Metrics in the cluster
        • Search Engine metric (server)
        MetricDescription
        SES_ALL_METRICSAll Metrics in Search Engine
        • Interval
        MetricDescription
        Min1Search every minute (maximum one day)
        Min5Search every 5 minutes (maximum one week)
        Min30Search every 30 minutes (maximum one month)
        Hour2Search every 2 hours (maximum 3 months)
        Day1Search everyday (maximum one year)

        Request example

        GET https://vpcsearchengine.apigw.ntruss.com/api/v2/monitoring/getSearchEngineMonitoringData/1768175
        ?computeInstanceNo=2416997
        &metric=SES_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=SES_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

        Response parameters

        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

        Field

        Parameter nameTypeDescription
        dataListInformation of monitoring data
        dpsList<ArrayList>Monitoring information (timestamp, data format)
        aggregationStringAggregation functions of the searched data
        dimensionsDimensionsVoSeparators of the searched data
        intervalStringAggregation interval of the searched data
        metricStringName of the searched metric
        graphNameStringGraph name
        productNameStringProduct name
        serviceGroupInstanceNoStringService group instance number of the searched cluster
        instanceNoStringCompute instance number of the searched server

        Response example

        {
          "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

        Was this article helpful?

        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.