Search Engine Monitoringデータを照会

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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]

リクエストヘッダ

ヘッダ名	説明
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	NAVERクラウドプラットフォームポータルから発行された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	照会するクラスタの番号です。
timeStart	Long	Y	照会開始時間(Millisecond)
timeEnd	Long	Y	照会終了時間(Millisecond)
metric	String	Y	照会したいmetric名
computeInstanceNo	String	Y	照会するサーバのCompute Instance No(Cluster Metricを照会する時、マネージャーサーバのCompute Instance No)
interval	String	N	集計周期(default: Min1)

Search Engine Metric(Cluster)
呼び出し時に、必ず、computeInstanceNoはマネージャーサーバのうち、いずれかのcomputeInstanceNoを入力しなければなりません。

Metric	Description
CLUSTER_ALL_METRICS	クラスタ内のすべてMetric

Search Engine Metric(サーバ)

Metric	Description
SES_ALL_METRICS	Search EngineのすべてのMetric

Interval

Metric	Description
Min1	1分間隔で照会(最大1日)
Min5	5分間隔で照会(最大1週間)
Min30	30分間隔で照会(最大1ヶ月)
Hour2	2時間間隔で照会(最大3ヶ月)
Day1	1日間隔で照会(最大1年)

リクエスト例

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

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=" \

レスポンスパラメータ

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;
}

フィールド

パラメータ名	タイプ	説明
data	List	Monitoringデータ情報
dps	List<ArrayList	モニタリング情報(timestamp、データ形態)
aggregation	String	照会するデータの集計関数
dimensions	DimensionsVo	照会するデータの区切り文字
interval	String	照会するデータの集計周期
metric	String	照会したいMetric名
graphName	String	グラフ名
productName	String	商品名
serviceGroupInstanceNo	String	照会するClusterのService Group Instance No
instanceNo	String	照会するサーバの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"
}

この記事は役に立ちましたか?

What's Next

Snapshotの作成

説明
リクエスト
レスポンスパラメータ
フィールド

タグ

Search Engine Service