URL-адрес запроса

GET

https://api.dotcom-monitor.com/config_api_v1/устройство/ {device_id}

Получите настройку устройства по его идентификатору.

Параметры пути

поле Type Обязательно описание
device_id

струна

true

 Уникальный идентификатор устройства мониторинга. Чтобы запросить список идентификаторов устройств на платформе, см. API: Получить список устройств по платформам.

Чтобы просмотреть идентификатор устройства из учетной записи dotcom-monitor, откройте оконечную устройство в списке Диспетчер устройств для редактирования. В адресной строке браузера вы увидите что-то вроде:

https://user.dotcom-monitor.com/ClientID/DeviceEdit?pid=dc7f4ff2ca944dekjh1078b96707002&deviceId=63698&taskId=132834

УстройствоId’63698 является идентификатором устройства.

Реакция на успех

Пример объекта JSON устройства ServerView/BrowserView 
{
    "Avoid_Simultaneous_Checks": false,
    "Alert_Silence_Min": 94,
    "False_Positive_Check": false,
    "Locations": [
        1,
        4,
        6,
        14,
        15,
        17,
        19,
        23,
        43,
        71,
        73
    ],
    "Tags": null,
    "ContextParams": [],
    "Send_Uptime_Alert": false,
    "Status_Description": "POSTPONED",
    "Postpone": true,
    "Owner_Device_Id": 0,
    "Frequency": 10800,
    "Filter_Id": 7791,
    "Scheduler_Id": 0,
    "Notifications": {
        "E_Mail_Flag": false,
        "E_Mail_Address": null,
        "E_Mail_TimeInterval_Min": 0,
        "WL_Device_Flag": false,
        "WL_Device_Email_Address": null,
        "WL_Device_TimeInterval_Min": 0,
        "Pager_Flag": false,
        "Pager_Area_Code": null,
        "Pager_Phone": null,
        "Pager_Num_Code": null,
        "Pager_TimeInterval_Min": 0,
        "Phone_Flag": false,
        "Phone_Area_Code": null,
        "Phone_Phone": null,
        "Phone_TimeInterval_Min": 0,
        "SMS_Flag": false,
        "SMS_Phone": null,
        "SMS_TimeInterval_Min": 0,
        "Script_Flag": false,
        "Script_Batch_File_Name": null,
        "Script_TimeInterval_Min": 0,
        "SNMP_TimeInterval_Min": 0,
        "Teams_TimeInterval_Min": 0,
        "Slack_TimeInterval_Min": 0,
        "AlertOps_TimeInterval_Min": 0,
        "PagerDuty_TimeInterval_Min": 0,
        "Notification_Groups": []
    },
    "Id": 47432,
    "Number_Of_Tasks": 1,
    "WaitingForApproval": false,
    "Platform_Id": 1,
    "Package_Id": 52,
    "Name": "FullPageDomain.cs"
}

Описание полей

Эти поля используются для указания сведений об Устройстве в запросах API.

поле

Type

 описание

Avoid_Simultaneous_Checks

булев

 Указывает, допускается ли одновременная проверка из нескольких мест мониторинга. Доступно только для устройств ServerView.

пример:
"Avoid_Simultaneous_Checks": true

Alert_Silence_Min

int32

 ТОЛЬКО ДЛЯ ЧТЕНИЯ. Определяет период времени в минутах, когда все оповещения отключены. Чтобы отключить оповещения, используйте API: Отключить оповещения для устройства или API: Отключить оповещения для нескольких устройств.

пример:
"Alert_Silence_Min": 46

False_Positive_Check

булев

 При обнаружении ошибки мы запускаем ряд проверок, чтобы убедиться, что это не ложное оповещение. Эти проверки могут занять некоторое время, в зависимости от типа ошибки и количества задач в устройстве. Это может привести к некоторой задержке в оповещении о простое. Вы можете отключить (“истинное” состояние) ложноположивную проверку, чтобы обеспечить немедленное оповещение о простое, но это может привести к некоторым “ложным” предупреждениям. Мы рекомендуем НЕ отключать “Проверку ложных срабатываний”.

пример:
"False_Positive_Check": false

Местонахождения

массив int32

 Массив, содержащий идентификаторы расположения, назначенные указанному устройству. В запросах должно быть указано хотя бы одно местоположение.

пример:
"Locations": [1, 2, 4, 5, 8]

Теги

массив строки

 Массив, содержащий имена тегов, назначенных указанному устройству.

пример:
"Tags": ["green", "red", "black"]

Send_Uptime_Alert

булев

 Когда эта опция включена, вы получите оповещение, когда все обнаруженные ошибки будут устранены.

пример:
"Send_Uptime_Alert": false

Status_Description

струна

 ТОЛЬКО ДЛЯ ЧТЕНИЯ. Описание текущего состояния устройства.

пример:
"Status_Description": "POSTPONED"

откладывать

булев

 Мониторинг можно установить на паузу, оттеветив устройство.

пример:
"Postpone": true,

Owner_Device_Id

int32

 Это поле отражает идентификатор устройства владельца.

пример:
"Owner_Device_Id": 8534

Частота

int32

 Это поле отражает частоту мониторинга в секундах.

пример:
"Frequency": 10800

Filter_Id

int32

 Это поле отражает идентификатор фильтра, присвоенный устройству.

пример:
"Filter_Id": 853

Scheduler_Id

int32

 Это поле отражает идентификатор Расписание, назначенный устройству.

пример:
"Scheduler_Id": 534

Уведомления

массив объектов

 Указывает список настроек оповещения

Пример #1:
"Notifications":
{
"E_Mail_Flag": true,
"E_Mail_Address": "demo@at.com",
"E_Mail_TimeInterval_Min": 10
}
Пример #2:
"Notifications":
{
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}]
}

E_Mail_Flag

булев

 Определяет, будет ли отправлено оповещение по электронной почте.

пример:
"E_Mail_Flag": false

E_Mail_Address

струна

 Задает адрес электронной почты для оповещений по электронной почте.

пример:
"E_Mail_Address": "demo@company.com"

E_Mail_TimeInterval_Min

int32

 Это поле позволяет установить интервал между предупреждениями по электронной почте в течение нескольких минут

пример:
"E_Mail_TimeInterval_Min": 15

WL_Device_Flag

булев

 Определяет, будет ли отправлено оповещение о беспроводном устройстве.

пример:
"WL_Device_Flag": false

WL_Device_Email_Address

струна

 Это поле определяет беспроводное устройство, например телефон или пейджер, для оповещений.

пример:
"WL_Device_Email_Address": "wireless@company.com"

WL_Device_TimeInterval_Min

int32

 Это поле позволяет установить интервал между оповещениями беспроводных устройств в минутах.

пример:
"WL_Device_TimeInterval_Min": 13

Pager_Flag

булев

 Определяет, будут ли отправлены предупреждения пейджера.

пример:
"Pager_Flag": true

Pager_Area_Code

струна

 Пейджер код города.

пример:
"Pager_Area_Code": "917"

Pager_Phone

струна

 Пейджер телефон.

пример:
"Pager_Phone": "3214564"

Pager_Num_Code

струна

 Код для цифровых пейджеров.

пример:
"Pager_Num_Code": "225"

Pager_TimeInterval_Min

int32

 Это поле позволяет установить интервал между оповещениями пейджера в минутах.

пример:
"Pager_TimeInterval_Min": 5

Phone_Flag

булев

 Определяет, будут ли происходить оповещения о телефонных звонках. Для получения оповещений по телефону установится значение “истинного” и укажите номер телефона. Телефонные оповещения являются интерактивными, что позволяет отложить последующие оповещения, как только оповещение получено.

пример:
"Phone_Flag": true

Phone_Area_Code

струна

 Если код страны “1” (например, в США, Канаде и Карибском бассейне), введите код области и номер (например, 952-5134349). Для всех остальных кодов стран используйте приставку “011”, код страны и номер телефона (например, 011-44-95-2244392).

пример:
"Phone_Area_Cde": "952"

Phone_Phone

струна

 Номер телефона.

пример:
"Phone_Phone": "5134349"

Phone_TimeInterval_Min

int32

 Это поле позволяет установить интервал между телефонными звонками.

пример:
"Phone_TimeInterval_Min": 2

SMS_Flag

булев

 Определяет, будут ли отправлены SMS-оповещения.

пример:
"SMS_Flag": false

SMS_Phone

 струна Номер телефона с кодом страны (например: США – 1 952 513 4349; Великобритания 449524 4392). НЕ используйте в номере префикс международного набора, например «011».

пример:
"SMS_Phone": "19525134349"

SMS_TimeInterval_Min

int32

 Это поле позволяет установить интервал между SMS-оповещениями.

пример:
"SMS_TimeInterval_Min": 0

Script_Flag

булев

 Это поле определяет, будет ли оповещение выполняться пользовательскими сценариями оповещений.

пример:
"Script_Flag": false

Script_Batch_File_Name

струна

 Пользовательское имя файла скрипта. Скрипт должен быть уже установлен на сервере.

пример:
"Script_Batch_File_Name":"alerting.cs"

Script_TimeInterval_Min

int32

 Это поле позволяет установить интервал между пользовательскими предупреждениями скрипта.

пример:
"Script_TimeInterval_Min":5

Notification_Groups

массив объектов

 Указывает активные группы оповещения с их идентификатором и сменой времени. Смена времени — это опция, позволяющая создать процесс эскалации оповещения, основанный на продолжительности состояния ошибки, например, первая группа уведомлений может быть немедленно уведомлена, вторая после 10 минут простоя и третья группа после 60 минут простоя. Интервалы времени оповещения эскалации варьируются от трех до трех часов.

пример:
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}, {
"Id": 609,
"Time_Shift_Min": 20
}]

Number_Of_Tasks

int32

 READ ТОЛЬКО поле. Показывает количество задач под указанным устройством.

пример:
"Number_Of_Tasks": 15

идентификатор

int32

 READ ТОЛЬКО поле. Уникальный идентификатор устройства. Назначается автоматически при создании нового устройства. Используется для указания устройства в запросах.

пример:
"Id": 8533

Platform_Id

int32

 READ ТОЛЬКО поле. Каждая платформа (ServerView, UserView и т.д.) имеет свой собственный идентификатор. Узнайте, как получить идентификаторы платформ здесь.

пример:
"Platform_Id": 1

имя

струна

 Имя устройства.

пример:
"Name": "new name"