Создать хост мониторинга
Для того, чтобы создать новый хост мониторинга, необходимо отправить POST запрос по адресу https://api.1cloud.ru/monitoring/hosts.
Ответом будет JSON объект, данный объект будет содержать все атрибуты созданного хоста мониторинга.
Входные параметры
Название | Тип | Описание |
---|---|---|
Domain | string | Доменная запись, привязанная к хосту мониторинга |
Ipv4 | string | Ipv4 адрес хоста мониторинга |
Ipv6 | string | Ipv6 адрес хоста мониторинга |
Command | object | Команда, используемая для проверок хоста. Описание параметров данного объекта находится в таблицах ниже |
Zones | list | Список зон, из которых выполняется проверка хоста мониторинга (см. Метод "Получить список всех доступных точек проверки") |
EnableNotifications | boolean | Необходимо ли включить уведомления при изменении состояния хоста мониторинга |
Примечание: В запросе можно использовать только один из первых трех параметров
Параметры объекта Command
1. Ping
Название | Тип | Описание |
---|---|---|
Type | string | Тип команды, выполняющейся при проверке: Ping |
TimeoutSec | Number | Время ожидания выполнения команды в секундах: 5, 10, 15 |
IntervalSec | Number | Интервал выполнения команды в секундах: 60, 300, 900, 1800, 3600 |
2. Tcp
Название | Тип | Описание |
---|---|---|
Type | string | Тип команды, выполняющейся при проверке: Tcp |
TimeoutSec | Number | Время ожидания выполнения команды в секундах: 5, 10, 15 |
IntervalSec | Number | Интервал выполнения команды в секундах: 60, 300, 900, 1800, 3600 |
Port | Number | Номер порта, куда будет отправляться запрос команды: 1 - 65535 |
Send | string | Строка, отправляемая в запросе |
ExpectedAnswer | string | Строка, ожидаемая в ответе |
3. HttpGet
Название | Тип | Описание |
---|---|---|
Type | string | Тип команды, выполняющейся при проверке: HttpGet |
TimeoutSec | Number | Время ожидания выполнения команды в секундах: 5, 10, 15 |
IntervalSec | Number | Интервал выполнения команды в секундах: 60, 300, 900, 1800, 3600 |
Port | Number | Номер порта, куда будет отправляться запрос команды: 1 - 65535, по умолчанию - 80 |
Url | string | Абсолютный путь к ресурсу (Обязательный параметр) |
ExpectedStatus | string | Ожидаемая первая строка в ответе сервера (по-умолчанию: "HTTP/1") |
UseSsl | boolean | Используется ли SSL при обращению к ресурсу |
4. HttpPost
Название | Тип | Описание |
---|---|---|
Type | string | Тип команды, выполняющейся при проверке: HttpPost |
TimeoutSec | Number | Время ожидания выполнения команды в секундах: 5, 10, 15 |
IntervalSec | Number | Интервал выполнения команды в секундах: 60, 300, 900, 1800, 3600 |
Port | Number | Номер порта, куда будет отправляться запрос команды: 1 - 65535, по умолчанию - 80 |
Url | string | Абсолютный путь к ресурсу (Обязательный параметр) |
ExpectedStatus | string | Ожидаемая первая строка в ответе сервера (по-умолчанию: "HTTP/1") |
UseSsl | boolean | Используется ли SSL при обращению к ресурсу |
ContentType | string | Тип контента в теле запроса |
Body | string | Тело запроса |
5. HttpHead
Название | Тип | Описание |
---|---|---|
Type | string | Тип команды, выполняющейся при проверке: HttpHead |
TimeoutSec | Number | Время ожидания выполнения команды в секундах: 5, 10, 15 |
IntervalSec | Number | Интервал выполнения команды в секундах: 60, 300, 900, 1800, 3600 |
Port | Number | Номер порта, куда будет отправляться запрос команды: 1 - 65535, по умолчанию - 80 |
ExpectedStatus | string | Ожидаемая первая строка в ответе сервера (по-умолчанию: "HTTP/1") |
UseSsl | boolean | Используется ли SSL при обращению к ресурсу |
Выходные параметры
Название | Тип | Описание |
---|---|---|
Id | Number | Уникальный идентификатор хоста мониторинга |
ActiveTasks | list | Список активных задач, которые выполняются для данного хоста |
State | string | Статус хоста мониторинга на момент обработки запроса
|
Ipv4 | string | IpV4 адрес хоста мониторинга |
Ipv6 | string | IpV6 адрес хоста мониторинга |
Domain | string | Доменная запись для хоста мониторинга |
DateActivated | DateTime | Дата активации хоста мониторинга |
Пример запроса
curl -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer 75bb9805c018b1267b2cf599a38b95a3a811e2ef7ad9ca5ed838ea4c6bafaf50' "https://api.1cloud.ru/monitoring/hosts" -d '{"Command":{ "Type":"Ping", "TimeoutSec":5,"IntervalSec":60 },"Ipv4":"123.123.123.123", "Zones":["russia.msk"], "EnableNotifications": true }'
Request Header
Content-Type: application/json Authorization: Bearer 75bb9805c018b1267b2cf599a38b95a3a811e2ef7ad9ca5ed838ea4c6bafaf50
Пример ответа
{ "ActiveTasks": [ { "Id": 971, "Type": "HostCreate", "State": "New", "Progress": 0 } ], "Id": 219, "State": "New", "Ipv4": "123.123.123.123", "Ipv6": null, "Domain": null, "DateActivated": null }