Объект веб-сценария
Следующие объекты напрямую связаны с API webcheck.
Веб-сценарий
Объект веб-сценария имеет следующие свойства.
| Property | Type | Description |
|---|---|---|
| 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 | Глобальный уникальный идентификатор, используемый для связывания импортированных веб-сценариев с уже существующими. Если не указан, генерируется автоматически. Поведение свойства: - поддерживается, если веб-сценарий принадлежит шаблону |
Шаг сценария
Объект шага сценария определяет конкретную проверку веб-сценария. Он имеет следующие свойства.
| Property | Type | Description |
|---|---|---|
| name | string | Имя шага сценария. Поведение свойства: - required |
| no | integer | Порядковый номер шага в веб-сценарии. Поведение свойства: - required |
| url | string | URL для проверки. Поведение свойства: - required |
| 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 или полей запроса. Он имеет следующие свойства.
| Property | Type | Description |
|---|---|---|
| name | string | Имя заголовка/переменной/поля POST или GET. Property behavior: - required |
| value | string | Значение заголовка/переменной/поля POST или GET. Property behavior: - required |
Тег веб-сценария
Объект тега веб-сценария имеет следующие свойства.
| Property | Type | Description |
|---|---|---|
| tag | string | Имя тега веб-сценария. Поведение свойства: - обязательно |
| value | string | Значение тега веб-сценария. |