モニタリング結果の照会

VPC環境で利用できます。

Search Engineクラスタとノードサーバのモニタリングデータを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v2/monitoring/getSearchEngineMonitoringData/{serviceGroupInstanceNo} (韓国リージョン)
GET	/api/sgn-v2/monitoring/getSearchEngineMonitoringData/{serviceGroupInstanceNo} (シンガポールリージョン)
GET	/api/jpn-v2/monitoring/getSearchEngineMonitoringData/{serviceGroupInstanceNo} (日本リージョン)

リクエストヘッダ

Search Engine Service APIで共通して使用されるヘッダの詳細は、Search Engine Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`serviceGroupInstanceNo`	Integer	Required	クラスタインスタンス番号クラスタリストの照会を参照

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`timeStart`	Integer	Required	照会開始日時(ミリ秒) Unix Timestamp形式
`timeEnd`	Integer	Required	照会終了日時(ミリ秒) Unix Timestamp形式
`metric`	String	Required	Metricタイプ `CLUSTER_ALL_METRICS` \| `SES_ALL_METRICS` `CLUSTER_ALL_METRICS`: クラスタモニタリング Metric `SES_ALL_METRICS`: ノードモニタリング Metric
`computeInstanceNo`	Integer	Conditional	ノードのサーバインスタンス番号ノードリストの照会を参照 `metric`が`SES_ALL_METRICS`の場合、必ず入力
`interval`	String	Optional	集計周期 `Min1` (デフォルト) \| `Min5` \| `Min30` \| `Hour2` \| `Day1` `Min1`: 1分(最大1日) `Min5`: 5分(最大1週間) `Min30`: 30分(最大1か月) `Hour2`: 2時間(最大3か月) `Day1`: 1日(最大1年)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/monitoring/getSearchEngineMonitoringData/1037*****?timeStart=1742747874000&timeEnd=1742866674000&metric=SES_ALL_METRICS&computeInstanceNo=1037*****&interval=Min30' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	Integer	-	レスポンスコード
`message`	String	-	レスポンスメッセージ
`result`	Object	-	レスポンス結果
`result.data`	Array	-	モニタリングデータ
`requestId`	String	-	リクエスト ID UUID形式

`result.data`

result.dataの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`dps`	Array	-	照会結果データポイント(Unix Timestamp形式)、データの値の形式で表示
`aggregation`	String	-	集計関数
`dimensions`	Object	-	Dimension情報
`dimensions.instanceNo`	String	-	ノードのサーバインスタンス番号
`dimensions.Svc_group_instance_no`	String	-	クラスタインスタンス番号
`interval`	String	-	集計周期 `Min1` \| `Min5` \| `Min30` \| `Hour2` \| `Day1` `Min1`: 1分(最大1日) `Min5`: 5分(最大1週間) `Min30`: 30分(最大1か月) `Hour2`: 2時間(最大3か月) `Day1`: 1日(最大1年)
`metric`	String	-	Metricの名前
`graphName`	String	-	グラフ名
`productName`	String	-	商品名

レスポンスステータスコード

Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、Search Engine Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "data": [
            {
                "dps": [
                    [
                        1742749200000,
                        0.0
                    ],
                    [
                        1742751000000,
                        0.0
                    ],
                    [
                        1742752800000,
                        0.0
                    ],
                    ...
                ],
                "aggregation": "AVG",
                "dimensions": {
                    "instanceNo": "1037*****",
                    "Svc_group_instance_no": "1037*****"
                },
                "interval": "Min30",
                "metric": "Indexing Rate",
                "graphName": "Indexing Rate(/m)",
                "productName": "Search Engine Service(VPC)"
            },
            {
                "dps": [
                    [
                        1742749200000,
                        0.0
                    ],
                    [
                        1742751000000,
                        0.0
                    ],
                    [
                        1742752800000,
                        0.0
                    ],
                    ...
                ],
                "aggregation": "AVG",
                "dimensions": {
                    "instanceNo": "1037*****",
                    "Svc_group_instance_no": "1037*****"
                },
                "interval": "Min30",
                "metric": "Search Rate",
                "graphName": "Search Rate(/m)",
                "productName": "Search Engine Service(VPC)"
            },
            ...
        ]
    },
    "requestId": "1e588fe5-****-****-****-0aa1fb036293"
}