Get monitoring list

Article summary

Did you find this summary helpful?

Thank you for your feedback

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:

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

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`name`	String	-	Monitoring service name
`monitoringType`	String	-	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
`interval`	Integer	-	Monitoring execution interval (minute) `1` \| `5` \| `10`
`requestTimeout`	Integer	-	Monitoring request wait time (millisecond) `5000` \| `10000` \| `30000`
`runTimeout`	Integer	-	Monitoring scenario execution wait time (millisecond) `30000` \| `40000` \| `50000` \| `60000`
`serviceType`	String	-	Monitoring service type `PC` \| `MOBILE`
`serviceYn`	Boolean	-	Monitoring status `true` \| `false` `true`: started `false`: suspended
`methodType`	String	-	Monitoring request type `GET` \| `POST` \| `DELETE` \| `PUT`
`url`	String	-	Web service URL address Monitoring target
`historyId`	String	-	History management ID
`scenarioId`	Integer	-	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
    }
]

Was this article helpful?

What's Next

Get monitoring

Table of contents

Request
Response