モニタリングの照会

印刷する
共有
PDF

記事の要約

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

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

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

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

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://wms.apigw.ntruss.com/api/v1/scenarios/{scenarioId}' \
--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' \

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`scenarioId`	Integer	-	シナリオ ID
`name`	String	-	モニタリングサービス名
`monitoringType`	String	-	モニタリングタイプ `URL` \| `SCENARIO` `URL`: モニタリングシナリオステップに URLアクセスのステップだけ追加された場合 `SCENARIO`: モニタリングシナリオステップに URLアクセスを含め2つ以上のステップが追加された場合
`serviceType`	String	-	モニタリングのサービスタイプ `PC` \| `MOBILE` `PC` `MOBILE`
`interval`	Integer	-	モニタリング実行周期(分) `1` \| `5` \| `10`
`requestTimeout`	Integer	-	モニタリングのリクエスト待ち時間(ミリ秒) `5000` \| `10000` \| `30000`
`runTimeout`	Integer	-	モニタリングのシナリオ実行待ち時間(ミリ秒) `30000` \| `40000` \| `50000` \| `60000`
`serviceYn`	Boolean	-	モニタリングの状態 `true` \| `false` `true`: 開始 `false`: 一時停止
`methodType`	String	-	モニタリングのリクエストタイプ `GET` \| `POST` \| `DELETE` \| `PUT`
`url`	String	-	Webサービスの URL モニタリング対象
`lastMonitoringTime`	Long	-	直近のモニタリング収集時間 Unix Timestamp形式
`successCount`	Integer	-	モニタリング結果のうち、正常な件数基準: 00時~現在
`errorCount`	Integer	-	モニタリング結果のうち、エラー件数基準: 00時~現在
`avgLoadTime`	Integer	-	ページの平均ロード時間(ミリ秒)
`avgRunTime`	Integer	-	シナリオの平均実行時間(ミリ秒)
`locations`	Array	-	モニタリング測定 Agentが位置する国
`alarms`	Object	-	アラーム設定情報
`alarms.scenarioId`	Integer	-	アラームシナリオ ID
`alarms.name`	String	-	アラーム名
`alarms.threshold`	Integer	-	アラームのしきい値(件)
`alarms.interval`	Integer	-	アラームの送信周期(時間)
`alarms.period`	Integer	-	アラームのしきい値測定時間(分)
`alarms.useYn`	Boolean	-	アラームの使用有無 `true` \| `false` `true`: 使用 `false`: 使用しない
`alarms.creator`	Integer	-	アラーム作成者 NAVERクラウドプラットフォーム会員番号を表示
`alarms.templateId`	Integer	-	アラームのテンプレート ID
`alarms.smsEmailConfigs`	Array	-	SMS/EMAILの設定情報
`alarms.webhooks`	Array	-	Webhookの設定情報

`locations`

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

フィールド	タイプ	必須の有無	説明
`code`	String	-	国コード `KR` \| `USW` \| `JP` \| `SG` \| `DE`
`name`	String	-	国名 `韓国` \| `米国(西部)` \| `日本` \| `シンガポール` \| `ドイツ`

`smsEmailConfigs`

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

フィールド	タイプ	必須の有無	説明
`managerName`	String	-	通知対象の管理者名
`managerNo`	Integer	-	通知対象の管理者番号
`cellPhoneNo`	Integer	-	通知対象の電話番号
`memberNo`	Integer	-	通知対象の番号
`emailAddress`	String	-	通知対象のメールアドレス
`informType`	String	-	通知方法 `EMAIL` \| `SMS` \| `ESMS` `EMAIL`: メールで通知 `SMS`: SMSで通知 `ESMS`: メールと SMSで通知

`webhooks`

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

フィールド	タイプ	必須の有無	説明
`id`	Integer	-	Webhook ID
`name`	String	-	Webhook名
`url`	String	-	Webhook URL
`memberNo`	Integer	-	Webhook対象者 NAVERクラウドプラットフォーム会員番号を表示
`createdDate`	Integer	-	Webhookの作成日 Unix Timestamp形式
`updatedDate`	Integer	-	Webhookの更新日 Unix Timestamp形式

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

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

レスポンス例

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

{
    "scenarioId": 7488,
    "name": "test_ncloud",
    "monitoringType": "SCENARIO",
    "serviceType": "PC",
    "interval": 1,
    "requestTimeout": 5000,
    "runTimeout": 30000,
    "serviceYn": true,
    "methodType": "GET",
    "url": "https://www.ncloud.com",
    "lastMonitoringTime": 1728579720000,
    "successCount": 38,
    "errorCount": 0,
    "avgLoadTime": 2961,
    "avgRunTime": 4070,
    "locations": [
        {
            "code": "KR",
            "name": "韓国"
        }
    ],
    "alarms": {
        "scenarioId": 7488,
        "name": "Default",
        "threshold": 3,
        "interval": 1,
        "period": 3,
        "useYn": true,
        "creator": "*******",
        "templateId": 14355,
        "smsEmailConfigs": [
            {
                "managerName": "田中太郎",
                "managerNo": 88139,
                "cellPhoneNo": "010********",
                "memberNo": 88139,
                "emailAddress": "gildong.hong@*****.com",
                "informType": "EMAIL"
            }
        ],
        "webhooks": [
            {
                "id": 113,
                "name": "wh_ncloud",
                "url": "https://www.ncloud.com",
                "memberNo": *******,
                "createdDate": 1728579753484,
                "updatedDate": 1728579753484
            }
        ]
    }
}

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

What's Next

モニタリング結果の照会

リクエスト
レスポンス

タグ

Web service Monitoring System