モニタリング結果の照会
- 印刷する
- PDF
モニタリング結果の照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
モニタリングサービスの結果を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /api/v1/scenarios/{scenarioId}/results |
リクエストヘッダ
Web service Monitoring System APIで共通して使用されるヘッダの詳細は、Web service Monitoring Systemのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
scenarioId | Integer | Required | シナリオ ID
|
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
from | Long | Required | 照会開始時間
|
to | Long | Required | 照会終了時間
|
type | String | Required | モニタリング結果のデータタイプ
|
resultStatus | String | Optional | モニタリングの結果
|
locationTypeCodes | String | Optional | モニタリング測定 Agentが位置する国
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://wms.apigw.ntruss.com/api/v1/scenarios/{scenarioId}/results?from=1696790400&to=1697404800&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が位置する国
|
resultStatus | String | Optional | モニタリングの結果
|
avgLoadTime | Integer | - | ページの平均ロード時間(ミリ秒) |
avgRunTime | Integer | - | シナリオの平均実行時間(ミリ秒) |
collectTime | Long | - | シナリオ集計の基準時間
|
stime1d | Long | - | シナリオ集計の基準日
|
successCount | Integer | - | モニタリング結果のうち、正常な件数
|
errorCount | Integer | - | モニタリング結果のうち、エラー件数
|
totalCount | Integer | - | モニタリング結果の総件数
|
レスポンスステータスコード
Web service Monitoring System APIで共通して使用されるレスポンスステータスコードの詳細は、Web service Monitoring Systemのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"avgLoadTime": 1408,
"avgRunTime": 3526,
"successCount": 720,
"errorCount": 0,
"totalCount": 720,
"availability": 100,
"results": [
{
"_id": "609287d081869e5f2eedeb8a",
"scenarioId": 1,
"locationTypeCode": "KR",
"resultStatus": "SUCCESS",
"avgLoadTime": 1472,
"avgRunTime": 3587,
"collectTime": 1620215700000,
"stime1d": 1620140400000,
"successCount": 5,
"errorCount": 0,
"totalCount": 5
},
{
"_id": "609287d081869e5f2eedeb8b",
"scenarioId": 1,
"locationTypeCode": "JP",
"resultStatus": "SUCCESS",
"avgLoadTime": 1383,
"avgRunTime": 3496,
"collectTime": 1620215700000,
"stime1d": 1620140400000,
"successCount": 5,
"errorCount": 0,
"totalCount": 5
},
...
]
}
この記事は役に立ちましたか?