モニタリング詳細結果の照会

Classic/VPC環境で利用できます。

モニタリングサービスの詳細結果を照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/scenarios/{scenarioId}/results/{resultId}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`scenarioId`	Integer	Required	シナリオ ID モニタリングリストの照会を通じて確認可能
`resultId`	Integer	Required	モニタリング結果 ID モニタリング結果の照会を通じて確認可能

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

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

フィールド	タイプ	必須の有無	説明
`type`	String	Required	モニタリング結果のデータタイプ `RAW` \| `MIN5` \| `MIN30` \| `MIN30` `RAW`: すべて `MIN5`: 5分集計 `MIN30`: 30分集計 `HOUR2`: 2時間集計 `DAY1`: 1日集計

リクエスト例

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

curl --location --request GET 'https://wms.apigw.ntruss.com/api/v1/scenarios/{scenarioId}/results/{resultId}?type=MIN5' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`avgLoadTime`	Integer	-	ページの平均ロード時間(ミリ秒)
`avgRunTime`	Integer	-	シナリオの平均実行時間(ミリ秒)
`successCount`	Integer	-	モニタリング結果のうち、正常な件数基準: 照会期間
`errorCount`	Integer	-	モニタリング結果のうち、エラー件数基準: 照会期間
`totalCount`	Integer	-	モニタリング結果の総件数基準: 照会期間
`availability`	Integer	-	サービスの可用性基準: 照会期間
`results`	Array	-	モニタリングの詳細結果

`results`

resultsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`_id`	String	-	モニタリング結果 ID
`scenarioId`	Integer	-	シナリオ ID
`locationTypeCodes`	String	Optional	モニタリング測定 Agentが位置する国 `KR` \| `USW` \| `JP` \| `SG` \| `DE` `KR`: 韓国 `USW`: 米国(西部) `JP`: 日本 `SG`: シンガポール `DE`: ドイツ 2つ以上選択時はコンマ「,」で区切る
`resultStatus`	String	Optional	モニタリングの結果 `SUCCESS` \| `ERROR` `SUCCESS`: 成功 `ERROR`: 失敗
`avgLoadTime`	Integer	-	ページの平均ロード時間(ミリ秒)
`avgRunTime`	Integer	-	シナリオの平均実行時間(ミリ秒)
`collectTime`	Long	-	シナリオ集計の基準時間 Unix Timestamp形式
`stime1d`	Long	-	シナリオ集計の基準日 Unix Timestamp形式
`successCount`	Integer	-	モニタリング結果のうち、正常な件数基準: 照会期間
`errorCount`	Integer	-	モニタリング結果のうち、エラー件数基準: 照会期間
`totalCount`	Integer	-	モニタリング結果の総件数基準: 照会期間
`stime5m`	Long	-	シナリオ集計の基準時間(5分)
`stime30m`	Long	-	シナリオ集計の基準時間(30分)
`stime2h`	Long	-	シナリオ集計の基準時間(2時間)
`startTime`	Long	-	シナリオ開始時間
`endTime`	Long	-	シナリオ終了時間
`transactions`	Array	-	シナリオステップ実行結果

`transactions`

transactionsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`stepId`	Integer	-	モニタリングシナリオステップ ID
`name`	String	-	モニタリングシナリオステップ名
`resultStatus`	String	-	モニタリングシナリオステップの実行結果 `SUCCESS` \| `ERROR` `SUCCESS`: 成功 `ERROR`: 失敗
`startTime`	Long	-	モニタリングシナリオステップの開始時間 Unix Timestamp形式
`endTime`	Long	-	モニタリングシナリオステップの終了時間 Unix Timestamp形式
`logs`	Array	-	モニタリングシナリオステップの実行結果ログ

`logs`

logsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	Integer	-	エラーコード
`harPath`	String	-	HARファイルパス
`imagePath`	String	-	画像ファイルパス
`msg`	String	-	エラーメッセージ
`time`	Long	-	エラー発生時間 Unix Timestamp形式
`type`	String	-	エラー検知タイプ

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

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

レスポンス例

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

{
  "avgLoadTime": 1472,
  "avgRunTime": 3587,
  "successCount": 5,
  "errorCount": 0,
  "totalCount": 5,
  "availability": 100,
  "results": [
    {
      "_id": "609286c23ca80f493050370e",
      "scenarioId": 1,
      "locationTypeCode": "KR",
      "resultStatus": "SUCCESS",
      "avgLoadTime": 1463,
      "avgRunTime": 3571,
      "collectTime": 1620215460000,
      "stime1d": 1620140400000,
      "successCount": 1,
      "errorCount": 0,
      "totalCount": 1,
      "stime5m": 1620215700000,
      "stime30m": 1620216000000,
      "stime2h": 1620219600000,
      "startTime": 1620215485512,
      "endTime": 1620215489083,
      "transactions": [
        {
          "transactionId": 35,
          "name": "NAVERクラウド",
          "resultStatus": "SUCCESS",
          "startTime": 1620215485512,
          "endTime": 1620215489083,
          "steps": [
            {
              "stepId": 82,
              "name": "URLアクセス",
              "resultStatus": "SUCCESS",
              "startTime": 1620215485527,
              "endTime": 1620215486990,
              "logs": []
            },
            {
              "stepId": 83,
              "name": "マウスクリック",
              "resultStatus": "SUCCESS",
              "startTime": 1620215486993,
              "endTime": 1620215487566,
              "logs": []
            },
            {
              "stepId": 84,
              "name": "待機時間",
              "resultStatus": "SUCCESS",
              "startTime": 1620215487568,
              "endTime": 1620215488567,
              "logs": []
            },
            {
              "stepId": 85,
              "name": "テキストの入力",
              "resultStatus": "SUCCESS",
              "startTime": 1620215488569,
              "endTime": 1620215489082,
              "logs": []
            }
          ]
        }
      ]
    },
    
    ...
    
  ]
}