Объект веб-сценария

Следующие объекты напрямую связаны с API webcheck.

Веб-сценарий

Объект веб-сценария имеет следующие свойства.

Свойство Type Описание
httptestid ID ID веб-сценария.

Поведение свойства:
- только для чтения
- обязательно для операций обновления
hostid ID ID узла сети, которому принадлежит веб-сценарий.

Поведение свойства:
- постоянное
- обязательно для операций создания
name string Имя веб-сценария.

Поведение свойства:
- обязательно для операций создания
agent string Строка user agent, которая будет использоваться веб-сценарием.

По умолчанию: Zabbix
authentication integer Метод аутентификации, который будет использоваться веб-сценарием.

Возможные значения:
0 - (по умолчанию) нет;
1 - базовая HTTP-аутентификация;
2 - NTLM-аутентификация;
3 - Kerberos-аутентификация;
4 - Digest-аутентификация.
delay string Интервал выполнения веб-сценария.

Допускаются секунды или единица времени с суффиксом (например, 30s, 1m, 2h, 1d), либо пользовательский макрос.

По умолчанию: 1m.
headers array HTTP-заголовки, которые будут отправлены при выполнении запроса.
http_password string Пароль, используемый для базовой HTTP-, NTLM-, Kerberos- или Digest-аутентификации.
http_proxy string Прокси, который будет использоваться веб-сценарием, в формате http://\[username\[:password\]@\]proxy.example.com\[:port].
http_user string Имя пользователя, используемое для базовой HTTP-, NTLM-, Kerberos- или Digest-аутентификации.
retries integer Количество попыток выполнения каждого шага веб-сценария перед ошибкой.

По умолчанию: 1.
ssl_cert_file string Имя файла SSL-сертификата, используемого для аутентификации клиента (должен быть в формате PEM).
ssl_key_file string Имя файла закрытого SSL-ключа, используемого для аутентификации клиента (должен быть в формате PEM).
ssl_key_password string Пароль закрытого SSL-ключа.
status integer Включен ли веб-сценарий.

Возможные значения:
0 - (по умолчанию) включен;
1 - отключен.
templateid ID ID родительского веб-сценария шаблона.

Поведение свойства:
- только для чтения
variables array Переменные веб-сценария.
verify_host integer Следует ли проверять, что имя узла сети для соединения совпадает с именем в сертификате узла сети.

Возможные значения:
0 - (по умолчанию) пропустить проверку узла сети;
1 - проверять узел сети.
verify_peer integer Следует ли проверять подлинность сертификата узла сети.

Возможные значения:
0 - (по умолчанию) пропустить проверку peer;
1 - проверять peer.
uuid string Глобальный уникальный идентификатор, используемый для связывания импортированных веб-сценариев с уже существующими. Генерируется автоматически, если не указан.

Поведение свойства:
- поддерживается, если веб-сценарий принадлежит шаблону

Шаг сценария

Объект шага сценария определяет конкретную проверку веб-сценария. Он имеет следующие свойства.

Свойство Тип Описание
name string Имя шага сценария.

Поведение свойства:
- обязательно
no integer Порядковый номер шага в веб-сценарии.

Поведение свойства:
- обязательно
url string URL для проверки.

Поведение свойства:
- обязательно
follow_redirects integer Следовать ли HTTP-перенаправлениям.

Возможные значения:
0 - не следовать перенаправлениям;
1 - (по умолчанию) следовать перенаправлениям.
headers array HTTP-заголовки, которые будут отправлены при выполнении запроса. Заголовки шага сценария перезаписывают заголовки, указанные для веб-сценария.
posts string/array Переменные HTTP POST в виде строки (необработанные данные post-запроса) или в виде массива HTTP-полей (данные полей формы).
required string Текст, который должен присутствовать в ответе.
retrieve_mode integer Часть HTTP-ответа, которую должен получить шаг сценария.

Возможные значения:
0 - (по умолчанию) только тело;
1 - только заголовки;
2 - заголовки и тело.
status_codes string Диапазоны требуемых HTTP-кодов состояния, разделенные запятыми.
timeout string Тайм-аут запроса в секундах. Допускаются секунды, единица времени с суффиксом или пользовательский макрос.

По умолчанию: 15s. Максимум: 1h. Минимум: 1s.
variables array Переменные шага сценария.
query_fields array Поля запроса — массив HTTP-полей, которые будут добавлены к URL при выполнении запроса.

Поле HTTP

Объект поля HTTP определяет имя и значение, используемые для указания переменных веб-сценария, HTTP-заголовков, а также полей POST или полей запроса. Он имеет следующие свойства.

Свойство Тип Описание
name string Имя заголовка/переменной/поля POST или GET.

Поведение свойства:
- обязательно
value string Значение заголовка/переменной/поля POST или GET.

Поведение свойства:
- обязательно

Тег веб-сценария

Объект тега веб-сценария имеет следующие свойства.

Свойство Тип Описание
tag string Имя тега веб-сценария.

Поведение свойства:
- обязательно
value string Значение тега веб-сценария.

Поведение свойства:
- только для чтения.
object integer Тип объекта, от которого был унаследован тег.

Возможные значения:
0 - шаблон;
1 - узел сети.

Поведение свойства:
- только для чтения.
objectid ID ID объекта, от которого был унаследован тег.

Поведение свойства:
- только для чтения.