Monitoring details
- Print
- PDF
Monitoring details
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
Search detailed information of URLs or scenarios.
Request URL
GET https://wms.apigw.ntruss.com/api/v1/scenarios/{scenarioId}
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
Path Variables
| Category | Required | Type | Description | Note |
|---|---|---|---|---|
| scenarioId | Yes | Integer | Scenario ID | ID issued per service registered for monitoring |
Example
Request example
GET https://wms.apigw.ntruss.com/api/v1/scenarios/1
Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
Response example
{
"scenarioId": 1,
"name": "NAVER Cloud",
"monitoringType": "URL",
"serviceType": "PC",
"interval": 1,
"requestTimeout": 5000,
"runTimeout": 30000,
"serviceYn": true,
"methodType": "GET",
"url": "https://www.ncloud.com",
"lastMonitoringTime": 1620125880000,
"successCount": 1157,
"errorCount": 42,
"avgLoadTime": 2389,
"avgRunTime": 2397,
"locations": [
{
"code": "KR",
"name": "한국"
}
],
"alarms": {
"scenarioId": 1,
"name": "Default",
"threshold": 3,
"interval": 1,
"period": 3,
"useYn": true,
"creator": "1",
"templateId": 11,
"smsEmailConfigs": [],
"webhooks": [
{
"id": 1,
"name": "webhhok",
"url": "https://hooks.slack.com/services/....",
"memberNo": 1,
"createdDate": 1620125893424,
"updatedDate": 1620125893424
}
]
}
}
| Category | Type | Description | Note |
|---|---|---|---|
| scenarioId | Integer | Scenario ID | |
| name | String | Service name | |
| monitoringType | String | Monitoring type | URL / SCENARIO |
| serviceType | String | Service type | PC / MOBILE |
| interval | Integer | Monitoring cycle | |
| requestTimeout | Integer | Request timeout (milliseconds) | |
| runTimeout | Integer | Run timeout (milliseconds) | |
| serviceYn | Boolean | Monitoring status | true: Start false: Stop |
| methodType | String | Request type | GET / POST / DELETE / PUT |
| url | String | URL | |
| lastMonitoringTime | Long | Time of latest monitoring collection | |
| successCount | Integer | Number of monitoring results as normal | Base period: 00:00 to now |
| errorCount | Integer | Number of errors detected | Base period: 00:00 to now |
| avgLoadTime | Integer | Average page load time | |
| avgRunTime | Integer | Average scenario run time | |
| locations.code | String | Country code | KR: Korea USW: United States (West) JP: Japan HK: Hong Kong SG: Singapore DE: Germany |
| locations.name | String | Country name | |
| alarms.threshold | Integer | Notification threshold (cases) | |
| alarms.period | Integer | Notification threshold measuring period (minutes) | |
| alarms.interval | Integer | Notification sending cycle (hours) | |
| alarms.useYn | Boolean | Notification usage status | |
| alarms.smsEmailConfigs.managerName | String | Notification recipient name | |
| alarms.smsEmailConfigs.cellPhoneNo | String | Notification recipient's mobile phone | |
| alarms.smsEmailConfigs.emailAddress | String | Notification recipient's email | |
| alarms.smsEmailConfigs.informType | String | Notification method | EMAIL/ESMS/SMS/NONE |
| webhooks.name | String | Webhook name | |
| webhooks.url | String | webhook url |
Error codes
These are common error codes that occur in response to WMS API requests.
| HTTP status code | Error codes | Error message | Description |
|---|---|---|---|
| 403 | E011 | Permission not found | No permissions. |
| 404 | E010 | Could not find the scenario. | Not Found. |
Response example
{
"errCode": "E010",
"errMessage": "Could not find the scenario."
}
| Parameter | Description |
|---|---|
| errCode | Error codes |
| errMessage | Error message |
Was this article helpful?