MENU
      Get monitoring list
        • PDF

        Get monitoring list

        • PDF

        Article summary

        Available in Classic and VPC

        Get the list of all monitoring services.

        Request

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

        MethodURI
        GET/api/v1/scenarios

        Request headers

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

        Request example

        The request example is as follows:

        curl --location --request GET 'https://wms.apigw.ntruss.com/api/v1/scenarios' \
        --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
        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
        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
        serviceTypeString-Monitoring service type
        • PC | MOBILE
        serviceYnBoolean-Monitoring status
        • true | false
          • true: started
          • false: suspended
        methodTypeString-Monitoring request type
        • GET | POST | DELETE | PUT
        urlString-Web service URL address
        • Monitoring target
        historyIdString-History management ID
        scenarioIdInteger-Scenario ID

        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:

        [
            {
                "name": "ncloud_test",
                "monitoringType": "SCENARIO",
                "interval": 1,
                "requestTimeout": 5000,
                "runTimeout": 30000,
                "serviceType": "PC",
                "serviceYn": true,
                "methodType": "GET",
                "url": "https://www.ncloud.com",
                "historyId": 1,
                "scenarioId": 7488
            },
            {
                "name": "example_test",
                "monitoringType": "URL",
                "interval": 1,
                "requestTimeout": 5000,
                "runTimeout": 30000,
                "serviceType": "PC",
                "serviceYn": true,
                "methodType": "GET",
                "url": "http://www.example.com",
                "historyId": 1,
                "scenarioId": 7479
            }
        ]
        JSON

        Was this article helpful?

        What's Next
        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.