モニタリングの照会

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

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

リクエスト

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

リクエストヘッダ

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

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

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

リクエスト例

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

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' \

レスポンス

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

レスポンスボディ

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

locations

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

smsEmailConfigs

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

webhooks

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

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

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