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

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

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

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

Свойство Тип Описание
httptestid строка (только чтение) ID веб-сценария.
hostid
(требуется)
строка ID узла сети, которому принадлежит веб-сценарий.
name
(требуется)
строка Имя веб-сценария.
agent строка Строка агента клиента, которая используется веб-сценарием.

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

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

По умолчанию: 1m.
headers строка устарело
массив полей HTTP
Заголовки HTTP, которые будут отправлены при выполнении запроса.
http_password строка Пароль используемый для аутентификации.

Требуется для веб-сценариев с простой HTTP или NTLM аутентификациями.
http_proxy строка Прокси, который используется веб-сценарием, задается в виде http://[имя пользователя[:пароль]@]proxy.example.com[:порт].
http_user строка Имя пользователя используемое для аутентификации.

Требуется для веб-сценариев с простой HTTP или NTLM аутентификациями.
nextcheck штамп времени (только чтение) Время следующего выполнения веб-сценария.
retries целое число Сколько раз веб-сценарий будет пытаться выполнять каждый шаг до ошибки.

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

Возможные значения:
0 - (по умолчанию) активирован;
1 - деактивирован.
templateid строка (только чтение) ID родительского веб-сценария из шаблона.
variables строка устарело
массив полей HTTP
Переменные веб-сценария.
verify_host целое число Необходимо ли проверять, что имя хоста, который указан в SSL сертификате совпадает с указанным в сценарии.

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

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

Шаг сценария

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

Свойство Тип Описание
httpstepid строка (только чтение) ID шага сценария.
name
(требуется)
строка Имя шага сценария.
no
(требуется)
целое число Порядковый номер шага в веб-сценарии.
url
(требуется)
строка Проверяемый URL.
follow_redirects целое число Необходимо ли следовать HTTP перенаправлениям.

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

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

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

В полях headers и variables разрешены как строки, так и массив полей HTTP в объектах веб-сценария и в объектах шага веб-сценария.
Строковый тип данных для headers и variables является устаревшим и будет удален в будущих версиях.

Поле HTTP

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

Свойство Тип Описание
name
(требуется)
строка Имя заголовка / переменной / полей POST или GET.
value
(требуется)
строка Значение заголовка / переменной / полей POST или GET.

HTTP field

The HTTP field object defines a name and value that is used to specify variable, HTTP header, POST form field data of query field data. It has the following properties.

Property Type Description
name
(required)
string Name of header / variable / POST or GET field.
value
(required)
string Value of header / variable / POST or GET field.