MENU
      Get monitoring

        Get monitoring


        Article summary

        Available in Classic and VPC

        Get the details of a monitoring service.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        GET/api/v1/scenarios/{scenarioId}

        Request headers

        For information about the headers common to all Web service Monitoring System APIs, see Web service Monitoring System request headers.

        Request path parameters

        You can use the following path parameters with your request:

        FieldTypeRequiredDescription
        scenarioIdIntegerRequiredScenario ID

        Request example

        The request example is as follows:

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

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        scenarioIdInteger-Scenario ID
        nameString-Monitoring service name
        monitoringTypeString-Monitoring type
        • URL | SCENARIO
          • URL: If only URL access steps are added to the monitoring scenario step
          • SCENARIO: If two or more steps are added to the monitoring scenario step including URL access
        serviceTypeString-Monitoring service type
        • PC | MOBILE
          • PC
          • MOBILE
        intervalInteger-Monitoring execution interval (minute)
        • 1 | 5 | 10
        requestTimeoutInteger-Monitoring request wait time (millisecond)
        • 5000 | 10000 | 30000
        runTimeoutInteger-Monitoring scenario execution wait time (millisecond)
        • 30000 | 40000 | 50000 | 60000
        serviceYnBoolean-Monitoring status
        • true | false
          • true: started
          • false: suspended
        methodTypeString-Monitoring request type
        • GET | POST | DELETE | PUT
        urlString-Web service URL address
        • Monitoring target
        lastMonitoringTimeLong-Last monitoring collection time
        • Unix timestamp format
        successCountInteger-Number of normal monitoring results
        • Criteria: 00:00 - current time
        errorCountInteger-Number of errors in monitoring results
        • Criteria: 00:00 - current time
        avgLoadTimeInteger-Average page load time (millisecond)
        avgRunTimeInteger-Average scenario execution time (millisecond)
        locationsArray-Country where the monitoring measurement agent is located
        alarmsObject-Notification configuration information
        alarms.scenarioIdInteger-Notification scenario ID
        alarms.nameString-Notification name
        alarms.thresholdInteger-Notification threshold (case)
        alarms.intervalInteger-Notification delivery interval (hour)
        alarms.periodInteger-Notification threshold measurement time (minute)
        alarms.useYnBoolean-Whether to use notifications
        • true | false
          • true: used
          • false: not used
        alarms.creatorInteger-Notification creator
        • Display the NAVER Cloud Platform member ID
        alarms.templateIdInteger-Notification template ID
        alarms.smsEmailConfigsArray-SMS/EMAIL configuration information
        alarms.webhooksArray-Webhook configuration information

        locations

        The following describes locations.

        FieldTypeRequiredDescription
        codeString-Country code
        • KR | USW | JP | SG | DE
        nameString-Country name
        • Korea | US (West) | Japan | Singapore | Germany

        smsEmailConfigs

        The following describes smsEmailConfigs.

        FieldTypeRequiredDescription
        managerNameString-Notification recipient admin name
        managerNoInteger-Notification recipient admin number
        cellPhoneNoInteger-Notification recipient phone number
        memberNoInteger-Notification recipient number
        emailAddressString-Notification recipient email address
        informTypeString-Notification method
        • EMAIL | SMS | ESMS
          • EMAIL: Notify via email
          • SMS: Notify via text
          • ESMS: Notify via email and text

        webhooks

        The following describes webhooks.

        FieldTypeRequiredDescription
        idInteger-Webhook ID
        nameString-Webhook name
        urlString-Webhook URL
        memberNoInteger-Webhook target
        • Display the NAVER Cloud Platform member ID
        createdDateInteger-Webhook creation date
        • Unix timestamp format
        updatedDateInteger-Webhook modification date
        • Unix timestamp format

        Response status codes

        For information about the HTTP status codes common to all Web service Monitoring System APIs, see Web service Monitoring System response status codes.

        Response example

        The response example is as follows:

        {
            "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": "Korea"
                }
            ],
            "alarms": {
                "scenarioId": 7488,
                "name": "Default",
                "threshold": 3,
                "interval": 1,
                "period": 3,
                "useYn": true,
                "creator": "*******",
                "templateId": 14355,
                "smsEmailConfigs": [
                    {
                        "managerName": "Gildong Hong",
                        "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
                    }
                ]
            }
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.